Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: small updates for the cert instructions #327

Merged
merged 2 commits into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions src/markdown/certificates/linux-install.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
1. Install the `certutil` tool using the appropriate command for your distribution:
- **Ubuntu/Debian**: `sudo apt install libnss3-tools`
1. Install the `certutil` tool using the appropriate command for your distribution:
- **Ubuntu/Debian**: `sudo apt install libnss3-tools`
- **RHEL/Fedora**: `sudo dnf install nss-tools`
2. Run the following command to install the certificate for your account:
2. Add the certificate to your account's NSS shared database:
```shell
certutil -d sql:$HOME/.pki/nssdb \
-A \
-t "C,," \
-n CodeGate-CA \
-i ~/Downloads/codegate.crt
-A -t "C,," -n CodeGate-CA \
-i ~/Downloads/codegate.crt
```
3. Restart VS Code.
2 changes: 1 addition & 1 deletion src/markdown/certificates/linux-remove.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. Run the following command to uninstall the certificate from your account:
1. Remove the certificate from your account:
```shell
certutil -d sql:$HOME/.pki/nssdb -D -n CodeGate-CA
```
Expand Down
20 changes: 8 additions & 12 deletions src/markdown/certificates/macos-install.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
### CLI method

After downloading the certificate, open a terminal and run the following command:
After downloading the certificate, open a terminal and run:

```shell
security add-trusted-cert \
-d \
-r trustRoot \
-p ssl \
-p basic \
-k ~/Library/Keychains/login.keychain \
~/Downloads/codegate.crt
security add-trusted-cert -d -r trustRoot -p ssl -p basic \
-k ~/Library/Keychains/login.keychain \
~/Downloads/codegate.crt
```

### GUI method

1. Open the downloaded certificate file; Keychain Access will open.
2. Depending on your macOS version, you may see the Add Certificates dialog. If so, select the `login` keychain, and click Add.
3. In Keychain Access, select the `login` keychain from the Default Keychains list on the left.
4. Search for "CodeGate" (it may not appear until you search), then in the search results, double-click the "CodeGate CA" certificate.
5. Expand the Trust section and set the "Secure Sockets Layer" and "X.509 Basic Policy" options to "Always Trust".
2. Depending on your macOS version, you may see the **Add Certificates** dialog. If so, select the `login` keychain and click **Add**.
3. In Keychain Access, select the **login** keychain from the list on the left.
4. Search for "CodeGate" (it may not appear until you search), then double-click the "CodeGate CA" certificate in the search results.
5. Expand the **Trust** section and set the "Secure Sockets Layer" and "X.509 Basic Policy" options to **Always Trust**.
15 changes: 7 additions & 8 deletions src/markdown/certificates/macos-remove.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
### CLI method

Open a terminal and run the following command:
Open a terminal and run:

```shell
security delete-certificate \
-c "CodeGate CA" \
-t ~/Library/Keychains/login.keychain
security delete-certificate -c "CodeGate CA" \
-t ~/Library/Keychains/login.keychain
```

### GUI method

1. Launch the Keychain Access app (Note: on newer macOS versions, Keychain Access is hidden from Launcher, but can be run from Spotlight Search).
2. Select the login keychain and search for "CodeGate".
3. Right-click the "CodeGate CA" certificate and Delete the certificate.
1. Launch the **Keychain Access** app. Note: on newer macOS versions, Keychain Access is hidden from Launcher but can be opened from Spotlight Search.
2. Select the **login** keychain and search for "CodeGate".
3. Right-click the "CodeGate CA" certificate and select **Delete "CodeGate CA"**.
4. Confirm the deletion when prompted.
8 changes: 4 additions & 4 deletions src/markdown/certificates/windows-install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
1. Double-click the downloaded certificate file.
2. Click "Install Certificate".
3. Select "Current User" and click Next.
2. Click **Install Certificate**.
3. Select "Current User" and click **Next**.
4. Choose "Place all certificates in the following store".
5. Click Browse and select "Trusted Root Certification Authorities".
6. Click Next and Finish.
5. Click **Browse** and select "Trusted Root Certification Authorities".
6. Click **Next** and then **Finish**.
2 changes: 1 addition & 1 deletion src/markdown/certificates/windows-remove.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
1. Open "Run" (Win + R) and enter `certmgr.msc`.
2. Navigate to "Trusted Root Certification Authorities" → "Certificates".
3. Find the "CodeGate CA" certificate.
4. Right-click and Delete the certificate.
4. Right-click the certificate and select **Delete**.
5. Confirm the deletion when prompted.
10 changes: 5 additions & 5 deletions src/routes/__tests__/route-certificates.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ describe('Certificates', () => {
).toBeVisible()
expect(screen.getByRole('heading', { name: 'GUI method' })).toBeVisible()
expect(
screen.getByText('Launch the Keychain Access app', { exact: false })
screen.getByText('Right-click the "CodeGate CA" certificate', {
exact: false,
})
).toBeVisible()
})

Expand All @@ -86,17 +88,15 @@ describe('Certificates', () => {

expect(
screen.getByText(
'Run the following command to install the certificate for your account:'
"Add the certificate to your account's NSS shared database:"
)
).toBeVisible()

await userEvent.click(
screen.getByRole('button', { name: 'Remove certificate' })
)
expect(
screen.getByText(
'Run the following command to uninstall the certificate from your account:'
)
screen.getByText('Remove the certificate from your account:')
).toBeVisible()
})
})
Loading