https://github.com/nmrshll/oauth2-noserver
Simplifying the oauth2 auth flow for desktop / cli apps that have no server side.
https://github.com/nmrshll/oauth2-noserver
cli desktop golang golang-library oauth2
Last synced: 2 months ago
JSON representation
Simplifying the oauth2 auth flow for desktop / cli apps that have no server side.
- Host: GitHub
- URL: https://github.com/nmrshll/oauth2-noserver
- Owner: nmrshll
- License: mit
- Created: 2017-06-24T07:53:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-18T21:48:29.000Z (almost 6 years ago)
- Last Synced: 2025-04-24T03:44:21.604Z (2 months ago)
- Topics: cli, desktop, golang, golang-library, oauth2
- Language: Go
- Homepage:
- Size: 77.1 KB
- Stars: 81
- Watchers: 3
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/nmrshll/oauth2-noserver)
# oauth2-noserver
Simplifying the oauth2 auth flow for desktop / cli apps that have no server side.
---
While oauth works fine for apps the have a server side, I personally find it a pain to use when developing simple desktop or cli applications.
That's why needed something to turn a complete oauth flow into a one-liner (well, that's clearly exaggerated, but it's barely more).
So here's how it works !
# Installation
Run `go get -u github.com/nmrshll/oauth2-noserver`
Try out the included example with `make example`
# Usage
#### 1. Create an oauth app on the website/service you want to authenticate into
You must set the redirection URL to `http://127.0.0.1:14565/oauth/callback` for this library to function properly.
Once done you should get credentials (`client id` and `client secret`) to use in your code.
#### 2. From your Go program, authenticate your user like this :
[embedmd]:# (./.docs/examples/quickstart/quickstart.go /func main/ $)
```go
func main() {
conf := &oauth2.Config{
ClientID: "________________", // also known as client key sometimes
ClientSecret: "___________________________", // also known as secret key
Scopes: []string{"account"},
Endpoint: oauth2.Endpoint{
AuthURL: "https://bitbucket.org/site/oauth2/authorize",
TokenURL: "https://bitbucket.org/site/oauth2/access_token",
},
}
client, err := oauth2ns.AuthenticateUser(conf)
if err != nil {
log.Fatal(err)
}
// use client.Get / client.Post for further requests, the token will automatically be there
_, _ = client.Get("/auth-protected-path")
}
```
The `AuthURL` and `TokenURL` can be found in the service's oauth documentation.
# Contributing
Have improvement ideas or want to help ? Please start by opening an [issue](https://github.com/nmrshll/oauth2-noserver/issues)
### Related
Used in:
- [google photos client library](https://github.com/nmrshll/google-photos-api-client-go)
- [google photos uploader cli](https://github.com/nmrshll/gphotos-uploader-cli)
#### License: [MIT](./.docs/LICENSE)