https://github.com/rwxrob/auth-go

https://github.com/rwxrob/auth-go

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/rwxrob/auth-go
• Owner: rwxrob
• License: apache-2.0
• Created: 2020-12-19T12:25:18.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-03-13T20:35:23.000Z (almost 5 years ago)
• Last Synced: 2024-10-04T16:58:19.565Z (over 1 year ago)
• Language: Go
• Size: 5.77 MB
• Stars: 10
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

README

          
# Go Oauth2 Helper Module

*Canonical source at *

![Oauth2 Session](doc/session.gif)

[![GoDoc](https://godoc.org/github.com/rwxrob/auth-go?status.svg)](https://godoc.org/github.com/rwxrob/auth-go)

[![License](https://img.shields.io/badge/license-Apache-brightgreen.svg)](LICENSE)

[![Go Report

Card](https://goreportcard.com/badge/github.com/rwxrob/auth-go)](https://goreportcard.com/report/github.com/rwxrob/auth-go)

[![Coverage](https://gocover.io/_badge/github.com/rwxrob/auth-go)](https://gocover.io/github.com/rwxrob/auth-go)

Designed to help make command line Oauth2 easier to implement and use

from shell scripts and other command line utilities.

## Example Usage

### Main

```

auth 

auth token 

auth grant 

auth refresh 

auth help

```

### Create, Replace, Update, Delete (CRUD)

```

auth add

auth rm 

auth edit

auth export  [ ...]

auth import  [ ...]

```

### View / Output

```

auth ls

auth conf 

auth json 

auth get access 

auth get refresh 

auth get type 

auth get expiry 

auth get state 

auth get code 

auth get id 

auth get secret 

auth get scopes 

auth get redirecturl 

auth get authurl 

auth get tokenurl 

auth get style 

```

### Embed

```

curl -H "Authorization: Bearer $(auth )" https://api.example.com/some

```

The `auth` command can be used in place of sensitive token and other

credential information within shell scripts. By default, the user will

be prompted when further authorization flow steps are needed, including

the opening of a local graphical web browser automatically. The level of

interaction can be isolated for scripts that must run without blocking

on waits for interactivity.

Unlike many other authorization solutions, `auth` starts a local web

server to handle the redirection and safely intercept the token that was

upgraded from the authorization code. Other tools generally prompt for

this to be cut and pasted in. If the opening of the web browser fails, a

prompt is shown instead.

## TODO

* Add Oauth 1.0a support (twitter)

* Add token revocation

* As much test coverage as we can achieve without a mock token server

* Add some detection of changes to the file since opened so don't

  overwrite with currently running process with the cache open (like vi)