go/authboss
1
0
Fork 0
mirror of https://github.com/volatiletech/authboss.git synced 2025-01-22 05:09:42 +02:00
Code Issues Releases Activity

Add oauth1 module docs to README.md

Browse Source
This commit is contained in:
Stephen Afam-Osemene 2020-07-06 02:19:35 +02:00
parent fddf30677c
commit a08329c355
No known key found for this signature in database
GPG Key ID: 355CFA69E4A34795
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -325,6 +325,7 @@ Confirm | github.com/volatiletech/authboss/v3/confirm | Prevents login before
Expire | github.com/volatiletech/authboss/v3/expire | Expires a user's login
Lock | github.com/volatiletech/authboss/v3/lock | Locks user accounts after authentication failures.
Logout | github.com/volatiletech/authboss/v3/logout | Destroys user sessions for auth/oauth2.
OAuth1 | github.com/stephenafamo/authboss-oauth1 | Provides oauth1 authentication for users.
OAuth2 | github.com/volatiletech/authboss/v3/oauth2 | Provides oauth2 authentication for users.
Recover | github.com/volatiletech/authboss/v3/recover | Allows for password resets via e-mail.
Register | github.com/volatiletech/authboss/v3/register | User-initiated account creation.
@ -411,6 +412,41 @@ It's very likely that you'd also want to enable the logout module in addition to
Direct a user to `GET /login` to have them enter their credentials and log in.
## User Auth via OAuth1
| Info and Requirements | |
| --------------------- | -------- |
Module | oauth1
Pages | _None_
Routes | /oauth1/{provider}, /oauth1/callback/{provider}
Emails | _None_
Middlewares | [LoadClientStateMiddleware](https://pkg.go.dev/github.com/volatiletech/authboss/#Authboss.LoadClientStateMiddleware)
ClientStorage | Session
ServerStorer | [OAuth1ServerStorer](https://pkg.go.dev/github.com/stephenafamo/authboss-oauth1?tab=doc#ServerStorer)
User | [OAuth1User](https://pkg.go.dev/github.com/stephenafamo/authboss-oauth1?tab=doc#User)
Values | _None_
Mailer | _None_
This is a tougher implementation than most modules because there's a lot going on. In addition to the
requirements stated above, you must also configure the `oauth1.Providers`. It's a public variable in the module.
```go
import oauth1 "github.com/stephenafamo/authboss-oauth1"
oauth1.Providers = map[string]oauth1.Provider{}
```
The providers require an oauth1 configuration that's typical for the Go oauth1 package, but in addition
to that they need a `FindUserDetails` method which has to take the token that's retrieved from the oauth1
provider, and call an endpoint that retrieves details about the user (at LEAST user's uid).
These parameters are returned in `map[string]string` form and passed into the `oauth1.ServerStorer`.
Please see the following documentation for more details:
* [Package docs for oauth1](https://pkg.go.dev/github.com/stephenafamo/authboss-oauth1)
* [oauth1.Provider](https://pkg.go.dev/github.com/stephenafamo/authboss-oauth1?tab=doc#Provider)
* [oauth1.ServerStorer](https://pkg.go.dev/github.com/stephenafamo/authboss-oauth1/#OAuth1ServerStorer)
## User Auth via OAuth2
| Info and Requirements | |