-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instructions for authenticating using Google oauth2 (#17527)
* Add instructions for authenticating using Google oauth2 Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com> * Add navigation link * Misc cleanup --------- Signed-off-by: Ian Bishop <151477169+ianb-mp@users.noreply.github.com> Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
- Loading branch information
1 parent
110b2b3
commit e6f41f7
Showing
4 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
|
||
This guide explains how to configure single sign-on (SSO) support for NetBox using [Google OAuth2](https://developers.google.com/identity/protocols/oauth2/web-server) as an authentication backend. | ||
|
||
## Google OAuth2 Configuration | ||
|
||
1. Log into [console.cloud.google.com](https://console.cloud.google.com/). | ||
2. Create new project for NetBox. | ||
3. Under "APIs and Services" click "OAuth consent screen" and enter the required information. | ||
4. Under "Credentials," click "Create Credentials" and select "OAuth 2.0 Client ID." Select type "Web application." | ||
- "Authorized JavaScript origins" should follow the format `http[s]://<netbox>[:<port>]` | ||
- "Authorized redirect URIs" should follow the format `http[s]://<netbox>[:<port>]/oauth/complete/google-oauth2/` | ||
5. Copy the "Client ID" and "Client Secret" values somewhere convenient. | ||
|
||
!!! note | ||
Google requires the NetBox hostname to use a public top-level-domain (e.g. `.com`, `.net`). The use of IP addresses is not permitted (except `127.0.0.1`). | ||
|
||
For more information, consult [Google's documentation](https://developers.google.com/identity/protocols/oauth2/web-server#prerequisites). | ||
|
||
## NetBox Configuration | ||
|
||
### 1. Enter configuration parameters | ||
|
||
Enter the following configuration parameters in `configuration.py`, substituting your own values: | ||
|
||
```python | ||
REMOTE_AUTH_BACKEND = 'social_core.backends.google.GoogleOAuth2' | ||
SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = '{CLIENT_ID}' | ||
SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = '{CLIENT_SECRET}' | ||
``` | ||
|
||
### 2. Restart NetBox | ||
|
||
Restart the NetBox services so that the new configuration takes effect. This is typically done with the command below: | ||
|
||
```no-highlight | ||
sudo systemctl restart netbox | ||
``` | ||
|
||
## Testing | ||
|
||
Log out of NetBox if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Google. Click that link. | ||
|
||
![NetBox Google login form](../../media/authentication/netbox_google_login.png) | ||
|
||
You should be redirected to Google's authentication portal. Enter the username/email and password of your test account to continue. You may also be prompted to grant this application access to your account. | ||
|
||
![NetBox Google login form](../../media/authentication/google_login_portal.png) | ||
|
||
If successful, you will be redirected back to the NetBox UI, and will be logged in as the Google user. You can verify this by navigating to your profile (using the button at top right). | ||
|
||
This user account has been replicated locally to NetBox, and can now be assigned groups and permissions. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters