2017-02-22 15:14:37 +08:00
# Goth: Multi-Provider Authentication for Go [](https://godoc.org/github.com/markbates/goth) [](https://travis-ci.org/markbates/goth)
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 ](https://github.com/intridea/omniauth ).
2018-02-19 13:10:51 +08:00
## Goth Needs a New Maintainer
[https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b ](https://blog.gobuffalo.io/goth-needs-a-new-maintainer-626cd47ca37b ) - TL;DR: I, @markbates , won't be responding to any more issues, PRs, etc... for this package. A new maintainer needs to be found ASAP. Is this you?
2017-02-22 15:14:37 +08:00
## Installation
```text
$ go get github.com/markbates/goth
```
## Supported Providers
* Amazon
* Auth0
2018-02-19 13:10:51 +08:00
* Azure AD
* Battle.net
2017-02-22 15:14:37 +08:00
* Bitbucket
* Box
* Cloud Foundry
* Dailymotion
* Deezer
* Digital Ocean
* Discord
* Dropbox
2018-02-19 13:10:51 +08:00
* Eve Online
2017-02-22 15:14:37 +08:00
* Facebook
* Fitbit
* GitHub
* Gitlab
* Google+
* Heroku
* InfluxCloud
* Instagram
* Intercom
* Lastfm
* Linkedin
* Meetup
2018-02-19 13:10:51 +08:00
* MicrosoftOnline
2017-02-22 15:14:37 +08:00
* OneDrive
* OpenID Connect (auto discovery)
* Paypal
* SalesForce
* Slack
* Soundcloud
* Spotify
* Steam
* Stripe
* Twitch
* Twitter
* Uber
2018-02-19 13:10:51 +08:00
* VK
2017-02-22 15:14:37 +08:00
* Wepay
2018-02-19 13:10:51 +08:00
* Xero
2017-02-22 15:14:37 +08:00
* Yahoo
* Yammer
## Examples
See the [examples ](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
```text
$ git clone git@github.com:markbates/goth.git
```
or use
```text
$ go get github.com/markbates/goth
```
```text
$ cd goth/examples
$ go get -v
2018-02-19 13:10:51 +08:00
$ go build
2017-02-22 15:14:37 +08:00
$ ./examples
```
Now open up your browser and go to [http://localhost:3000 ](http://localhost:3000 ) to see the example.
2018-02-19 13:10:51 +08:00
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` :
```go
& 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 follow snippet show one way to do this:
```go
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
```
2017-02-22 15:14:37 +08:00
## Issues
2018-02-19 13:10:51 +08:00
Issues always stand a significantly better chance of getting fixed if they are accompanied by a
2017-02-22 15:14:37 +08:00
pull request.
## Contributing
Would I love to see more providers? Certainly! Would you love to contribute one? Hopefully, yes!
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Write Tests!
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create new Pull Request
