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.

Sign up for GitHub

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

Clarify instructions for local SAML SSO #289

Merged
merged 5 commits into from
Feb 2, 2024
Merged

Clarify instructions for local SAML SSO #289

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4d5db2a
Clarify instructions for local SAML
trmartin4 Jan 31, 2024
5ace2cf
Updated "login" to log in
trmartin4 Jan 31, 2024
8e51a36
Added punctuation based on current convention in docs.
trmartin4 Jan 31, 2024
e40f53e
More punctuation.
trmartin4 Jan 31, 2024
ca30c95
Fixed the referenced step number in the docs.
trmartin4 Feb 1, 2024
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
24 changes: 12 additions & 12 deletions docs/getting-started/server/sso/local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,31 @@ This uses
- API
- SSO (located at `server/bitwarden_license/src/Sso`)

2. Local web client running
2. Local web client running.

## Configure IdP

1. Open your local web vault and navigate to your organization → Settings → Single Sign-On
1. Open your local web client and navigate to your organization → Settings → Single Sign-On.

2. Tick the "Allow SSO authentication" box
2. Tick the "Allow SSO authentication" box.

3. Come up with and enter an SSO Identifier
3. Come up with and enter an SSO Identifier.

4. Select "SAML 2.0" as the SSO type. Don't save or exit this page yet, you'll need to come back to
it later
it later.

5. Open a new terminal and navigate to the `dev` folder in your server repository, e.g.

```bash
cd ~/Projects/server/dev
```

6. Open your `.env` file and set the following environment variables, based on the "SP Entity ID"
and "Assertion Consumer Service (ACS) URL" values on the web vault SSO configuration page:
6. Open your `.env` file and set the following environment variables using the "SP Entity ID" and
"Assertion Consumer Service (ACS) URL" values from the SSO configuration page opened in step #2:
JaredSnider-Bitwarden marked this conversation as resolved.
Show resolved Hide resolved

```bash
IDP_SP_ENTITY_ID=http://localhost:51822/saml2
IDP_SP_ACS_URL=http://localhost:51822/saml2/yourOrgIdHere/Acs
IDP_SP_ENTITY_ID={SP Entity ID}
IDP_SP_ACS_URL={ACS URL}
```

:::note
Expand Down Expand Up @@ -85,12 +85,12 @@ This uses

10. You can test your user configuration by navigating to
[http://localhost:8090/simplesaml](http://localhost:8090/simplesaml), then Authentication → test
configured authentication sources → `example-userpass`. You should be able to login with the
configured authentication sources → `example-userpass`. You should be able to log in with the
users you’ve configured.

## Configure Bitwarden

1. Go back to your window with the SSO configuration page open
1. Go back to your window with the SSO configuration page open.
2. Complete the following values in the SAML Identity Provider Configuration section:

1. Entity ID:
Expand All @@ -103,7 +103,7 @@ This uses
```
3. X509 Public Certificate: get this by opening a new tab and navigating to the Entity ID URL
above. It will open (or download) an XML file. Copy and paste the value _between_ the
`<ds:X509Certificate>` tags (it should look like a B64 encoded string)
`<ds:X509Certificate>` tags (it should look like a B64 encoded string).

3. Save your SSO configuration

Expand Down