3abb25166c
Update markbates/goth to v1.61.2 - Fixes a JWT decoding issue in the OpenID provider - Updates the GitHub provider to use the authorization header for authentication - Updates the Twitch provider for Twitch's v5 API changes - Adds the email and is_private_email fields to the Apple provider's GetUser implementation - Modifies gothic to export a non-collidable context key for setting the Provider in a context.Context - Adds new scopes to the Spotify provider - Adds the IDToken from OpenID providers on the user struct - Make Apple provider's SecretParams public - Adds support for sign in with Apple, and drops support for Go versions 1.7 and 1.8 - Fixes the Slack provider's FetchURL logic to use the appropriate scope for the info it needs Signed-off-by: Oscar LÃfwenhamn <oscar.lofwenhamn@cgi.com> |
||
|---|---|---|
| .. | ||
| gothic | ||
| providers | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE.txt | ||
| README.md | ||
| doc.go | ||
| go.mod | ||
| go.sum | ||
| provider.go | ||
| session.go | ||
| user.go | ||
README.md
Goth: Multi-Provider Authentication for Go 
Package goth provides a simple, clean, and idiomatic way to write authentication packages for Go web applications.
Unlike other similar packages, Goth, lets you write OAuth, OAuth2, or any other
protocol providers, as long as they implement the Provider and Session interfaces.
This package was inspired by https://github.com/intridea/omniauth.
Installation
$ go get github.com/markbates/goth
Supported Providers
- Amazon
- Apple
- Auth0
- Azure AD
- Battle.net
- Bitbucket
- Box
- Cloud Foundry
- Dailymotion
- Deezer
- Digital Ocean
- Discord
- Dropbox
- Eve Online
- Fitbit
- Gitea
- GitHub
- Gitlab
- Google+ (deprecated)
- Heroku
- InfluxCloud
- Intercom
- Lastfm
- LINE
- Mailru
- Meetup
- MicrosoftOnline
- Naver
- Nextcloud
- OneDrive
- OpenID Connect (auto discovery)
- Paypal
- SalesForce
- Shopify
- Slack
- Soundcloud
- Spotify
- Steam
- Stripe
- Tumblr
- Twitch
- Typetalk
- Uber
- VK
- Wepay
- Xero
- Yahoo
- Yammer
- Yandex
Examples
See the examples folder for a working application that lets users authenticate through Twitter, Facebook, Google Plus etc.
To run the example either clone the source from GitHub
$ git clone git@github.com:markbates/goth.git
or use
$ go get github.com/markbates/goth
$ cd goth/examples
$ go get -v
$ go build
$ ./examples
Now open up your browser and go to http://localhost:3000 to see the example.
To actually use the different providers, please make sure you set environment variables. Example given in the examples/main.go file
Security Notes
By default, gothic uses a CookieStore from the gorilla/sessions package to store session data.
As configured, this default store (gothic.Store) will generate cookies with Options:
&Options{
Path: "/",
Domain: "",
MaxAge: 86400 * 30,
HttpOnly: true,
Secure: false,
}
To tailor these fields for your application, you can override the gothic.Store variable at startup.
The following snippet shows one way to do this:
key := "" // Replace with your SESSION_SECRET or similar
maxAge := 86400 * 30 // 30 days
isProd := false // Set to true when serving over https
store := sessions.NewCookieStore([]byte(key))
store.MaxAge(maxAge)
store.Options.Path = "/"
store.Options.HttpOnly = true // HttpOnly should always be enabled
store.Options.Secure = isProd
gothic.Store = store
Issues
Issues always stand a significantly better chance of getting fixed if they are accompanied by a pull request.
Contributing
Would I love to see more providers? Certainly! Would you love to contribute one? Hopefully, yes!
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Write Tests!
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request