Giter VIP home page Giter VIP logo

rchargel-goauth's Introduction

Goauth for Go

Build Status

The goauth package contains a simplified implementation of OAuth 1.0 and OAuth 2.0 spec for the Go programming language.

Installation

go get "github.com/rchargel/goauth"

Import

import "github.com/rchargel/goauth"

Documentation

The package documentation can be found at http://godoc.org/github.com/rchargel/goauth.

Here is the project page and a quick tutorial.

Dependencies

  • golang.org/x/oauth2 - the OAuth 2.0 service provider wraps this API.
  • gopkg.in/yaml.v2 - a YAML file reader.

Implementation Description

Package goauth is a simple to use and implement tool to configure OAuth authentication for your application or service. It relies on some of the OAuth tools already available for Go, but adds in some structure to reduce the complexity of your implementation. The intent is to make authentication easy by reducing the pain points to just a couple of configuration parameters.

This package provides two OAuth implementations, Version 1.0 and Version 2.0. For version 2.0 implementations the sequence of events is fairly straightforward.

Browser                    Server                   Provider
   |                          |                          |
   # GET: /oauth/provider     |                          |
   #==>==>==>==>==>==>==>==>=>#                          |
   |            Send Redirect #                          |
   #<=<==<==<==<==<==<==<==<==#                          |
   # Redirect to provider login                          |
   #==>==>==>==>==>==>==>==>==|==>==>==>==>==>==>==>==>=>#
   |                          |                          # User logs in
   |                          | Redirect to callback URL #
   #<=<==<==<==<==<==<==<==<==|==<==<==<==<==<==<==<==<==#
   # GET: Callback URL        |                          |
   #==>==>==>==>==>==>==>==>=>#                          |
   |                          # GET: User Info           |
   |                          #==>==>==>==>==>==>==>==>=>#
   |                          #<=<==<==<==<==<==<==<==<==#
   |                          # Process User             |
   |                          # Create Session           |
   |          Respond To User #                          |
   #<=<==<==<==<==<==<==<==<==#                          |
   #                          |                          |

For version 1.0 implementations the sequence of events is slightly more complex, however most of that complexity is hidden from you by the API.

Browser                    Server                    Provider
   |                          |                          |
   # GET: /oauth/provider     |                          |
   #==>==>==>==>==>==>==>==>=>#                          |
   |                          # Fetch OAuth Token        |
   |                          #==>==>==>==>==>==>==>==>=>#
   |                          #                          # Auth Request
   |                          #  Return Token and Secret #
   |                          #<=<==<==<==<==<==<==<==<==#
   |            Send Redirect #                          |
   #<=<==<==<==<==<==<==<==<==#                          |
   # Redirect to provider login                          |
   #==>==>==>==>==>==>==>==>==|==>==>==>==>==>==>==>==>=>#
   |                          |                          # User logs in
   |                          | Redirect to callback URL #
   #<=<==<==<==<==<==<==<==<==|==<==<==<==<==<==<==<==<==#
   # GET: Callback URL        |                          |
   #==>==>==>==>==>==>==>==>=>#                          |
   |                          # Fetch Access Token       |
   |                          #==>==>==>==>==>==>==>==>=>#
   |                          #                          # Auth Request
   |                          #      Return Access Token #
   |                          #<=<==<==<==<==<==<==<==<==#
   |                          # GET: User Info           |
   |                          #==>==>==>==>==>==>==>==>=>#
   |                          #<=<==<==<==<==<==<==<==<==#
   |                          # Process User             |
   |                          # Create Session           |
   |          Respond To User #                          |
   #<=<==<==<==<==<==<==<==<==#                          |
   #                          |                          |

Testing

So far, I have only tested this API with the following OAuth Providers:

  • OAuth 2.0
    • Google
    • Facebook
  • OAuth 1.0
    • Twitter

Contact Me

Contact me with any questions or comments through my website: http://zcarioca.net.

rchargel-goauth's People

Contributors

rchargel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.