Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shareed2k/goth_fiber

Package goth_fiber provides a simple, clean, and idiomatic way to write authentication packages for fiber framework applications.
https://github.com/shareed2k/goth_fiber

fiber-framework goth oauth oauth2

Last synced: about 3 hours ago
JSON representation

Package goth_fiber provides a simple, clean, and idiomatic way to write authentication packages for fiber framework applications.

Host: GitHub
URL: https://github.com/shareed2k/goth_fiber
Owner: Shareed2k
License: mit
Created: 2020-04-24T10:53:23.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-14T05:11:53.000Z (8 months ago)
Last Synced: 2024-03-14T06:27:15.042Z (8 months ago)
Topics: fiber-framework, goth, oauth, oauth2
Language: Go
Homepage:
Size: 391 KB
Stars: 80
Watchers: 2
Forks: 12
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Goth-Fiber: Multi-Provider Authentication for Go [![GoDoc](https://godoc.org/github.com/shareed2k/goth_fiber?status.svg)](https://godoc.org/github.com/shareed2k/goth_fiber)

Is wrapper for [goth library](https://github.com/markbates/goth) to use with [fiber Framework](https://github.com/gofiber/fiber), 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.

## Installation

```text
$ go get github.com/shareed2k/goth_fiber
```

## Supported Providers

- Amazon
- Apple
- Auth0
- Azure AD
- Battle.net
- Bitbucket
- Box
- Cloud Foundry
- Dailymotion
- Deezer
- Digital Ocean
- Discord
- Dropbox
- Eve Online
- Facebook
- Fitbit
- Gitea
- GitHub
- Gitlab
- Google
- Google+ (deprecated)
- Heroku
- InfluxCloud
- Instagram
- Intercom
- Kakao
- Lastfm
- Linkedin
- LINE
- Mailru
- Meetup
- MicrosoftOnline
- Naver
- Nextcloud
- OneDrive
- OpenID Connect (auto discovery)
- Paypal
- SalesForce
- Shopify
- Slack
- Soundcloud
- Spotify
- Steam
- Strava
- Stripe
- Tumblr
- Twitch
- Twitter
- Typetalk
- Uber
- VK
- Wepay
- Xero
- Yahoo
- Yammer
- Yandex

## 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 [email protected]/shareed2k/goth_fiber.git
```

```text
$ go get github.com/shareed2k/goth_fiber
```

```text
$ cd goth_fiber/examples
$ go get -v
$ go build
$ ./examples
```

Now open up your browser and go to [http://localhost:8088/login/google](http://localhost:8088/login/google) 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, goth_fiber uses a `Session` from the `gofiber/session` package to store session data.

As configured, goth will generate cookies with the following `session.Config`:

```go
session.Config{
Expiration: 24 * time.Hour,
Storage: memory.New(),
KeyLookup: "cookie:_gothic_session",
CookieDomain: "",
CookiePath: "",
CookieSecure: false,
CookieHTTPOnly: true,
CookieSameSite: "Lax",
KeyGenerator: utils.UUIDv4,
}
```

To tailor these fields for your application, you can override the `goth_fiber.SessionStore` variable at startup.

The following snippet shows one way to do this:

```go
// optional config
config := session.Config{
Expiration: 30 * time.Minutes,
Storage: sqlite3.New(), // From github.com/gofiber/storage/sqlite3
KeyLookup: "header:session_id",
CookieDomain: "google.com",
CookiePath: "/users",
CookieSecure: os.Getenv("ENVIRONMENT") == "production",
CookieHTTPOnly: true, // Should always be enabled
CookieSameSite: "Lax",
KeyGenerator: utils.UUIDv4,
}

// create session handler
sessions := session.New(config)

goth_fiber.SessionStore = sessions
```

## 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!

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