hero is a heroic oauth 2 provider, which is simple, elegant and beautiful.

According to this post

OAuth 2 is an authorization framework that enables applications to obtain limited access to user accounts on >an HTTP service, such as Facebook, GitHub, and DigitalOcean.

From the definition of oauth 2 above, there is example of providers that is Facebook,GitHub and DigitalOcean. hero enables you to become an oauth 2 provider just like Facebook ,GitHub and DigitalOcean.

This means, hero provides user accounts and also allows limited access to the accounts.Unlike the other options, with hero you have full control of everything.

Hero is a commadline application. It also offers a library that you can use to compose your own version of oauth 2 provider.

• create/update/delete user account
• passwords and client secrets are encrypted
• create/update/delete clients
• client authorization
• client authentication
• oauth 2 rfc 6974 compliant
• user profiles
• configurable (just see it for yourself)
• multiple databases( postgres, mysql and foundation)
• session management( via gorilla session and persisted in the database)
• hackable( I DARE YOU)
• sweet( use the codebase to learn more about go(Golang))

Hero is in early development a.k.a alpha state.

There is no oauth provider in my country(Tanzania), so I created one in a way that anyone who wants to be can have a starting point.

Prerequisite

• go(Golang) 1.5+

Go get the project to install it

go get github.com/gernetst/hero/cmd/hero

This will create the hero binary for you.

Alternatively you can download precompiled binaries for your favorite operating system.

[COMING SOON]

You need a configuration file in order to run hero server. The format supported is json. Hero comes with a command to bootstrap a configuration file with default settings, you can use it to customize the values as you fancy.I will explain the configurable details in a moment.

To generate default configuration file, run the following command,

hero genconf [Path to configuration file goes here e.g config.json]

This is content of an example default configuration file. You can also find it fixtures/config.json

{
	"redirect_separator": "",
	"authorization_expire": 200,
	"access_expire": 200,
	"allow_get_access": false,
	"allowed_access_type": [
		"authorization_code",
		"refresh_token",
		"password",
		"client_credentials",
		"assertion"
	],
	"token_type": "",
	"provider_name": "",
	"auth_endpoint": "/authorize",
	"token_endpoint": "/tokens",
	"info_endpoint": "/info",
	"port": 8090,
	"database_dialect": "postgres",
	"database_connection": "postgres://postgres:postgres@localhost/hero_test?sslmode=disable",
	"templates_dir": "views",
	"static_dir": "",
	"session_path": "/",
	"session_max_age": 0,
	"session_domain": "",
	"session_secure": false,
	"session_hhhponly": false,
	"session_name": "_hero",
	"Login_template": "login.html",
	"error_template": "error.html",
	"register_template": "",
	"client_template": "client.html",
	"profile_template": "profile.html",
	"home_template": "home.html"
}

Table to explain the configuration settings

Making a configuarble application is hard, so take this with a grain of salt.

The names of the templates needed by hero are found in the configuration file. If you are using the hero commandline application make sure the names are relative to the templates_dir configuration value.

You can create your own views, hero uses text/template templates. You should Invest in differnetiating your brand. hero ships with ready to use, ready to customize views for you, they can be found here views. You can help improve the default views, hero welcomes your contribution.

The following are the templates names and the form fields that are expected to be present when submitting values to the server.

The template name part of the tample refers to the value supplied in the configuration file.

The following is the table of data(context) passed to templates and their meaning

Run the service

hero --mingrate server [config_file_path]

where config_file_path is the path to the configuration file, it doisnt matter if the path is relative or absolute.

It is wise to add the --migrate flag if you are running for the first time so as to prepare the database.

You should see this on your stdout

running migrations...done 
starting hero service at  http://localhost:8090 

If you see anything diffenernt then open an issue.

Be a hero, fight against poverty in style. I have a vision, a way in which I can somehow make a difference in the fight against povert( Trust me, I'm in deep shit of poverty) in my country(Tanzania) with the power of open source and creative thinking.

The people who are entitled to make decisions( at the lowest level) ni my country , they have no idea what they are doing. So with the assist of data science, open source, science fiction and collaboration I hope one day a clone of me( yes the other version of me somewhere in the distant future) will have the chance to do what he wants to do with his full capacity.

Okay, time to be part of heroes squad. Before you leave this section please don't forget to star the project.

NOTE : For non trivial stuffs like typo fixes just use the GitHub interface and don't bother with the boring recomendation below. If you are not so sure, better open an issue.

Prerequisite

• A working go(Golang) environment
• go 1.5+
• database (mysql,postgres or foundation)
• make
• A brave heart

I am using a linux machine, so this is a linux based setup.

Fork the project on github. Assuming your github username is foo. After forking you should have the hero fork on your github repositories.

get the project

go get -v -u github.com/gernest/hero/cmd/hero

cd to the installed package

cd $GOPATH/src/github.com/gernest/hero

add your fork as remote call it heroes

git remote add heroes URL_TO_YOUR_FORK

where URL_TO_YOUR_FORK is the github url to your fork of hero e.g https://github.com/foo/hero

clean the development environment

make clean

Install dependencies

make deps

create a branch that you will be hacking on, let us call it fix

git checkout -b fix

Export the database connection setup. We need dialect and the connection url. Default values are DB_CONN=postgres://postgres:postgres@localhost/hero_test?sslmode=disable and DB_DIALECT=postgres

You can create your database anywhere, just make sure it is available and supported. For now mysql, postgresql and foundation are supported.

export DB_CONN=connection_url_to_my database
export DB_DIALECT=my_database_dialect

fireup the goconvey test runner. This will rebuild and run the tests whenever any file changes, and you will see the convrage and the tests run on your default browser.

make convey

Then hack on your fix branch.

If you are done hacking and the tests passed. Do some vetting and linting by running the following command.

make check

Well if you are done and the check passes.

commit your changes, and push to your fork( our case heroes)

git commit -m -a

git push heroes fix

Go to your github account and on your hero fork, open a pull request for your fix branch. I will review the pull request and merge it if the fix does what it says It can do.

If you are doing the front end or whatever and want to run the development server. First you should have somehow completed the boring recomendation above.

Then run the following command

make server

The above command will start the development server. Database migrations will be done Before the server is started.

The configuration file used by this server is at the root of this respository config_dev.json

Then you can view the home page by visiting http://localhost:8090

You dont need to refresh your browser when running the development server. Hero will live reload your service whenever changes are made be it in the templates or the static assets( please see configuration part and note the static_dir and templates_dir).

There is a simple demo bundled with this repository at hero/demo.

To run the demo just do this command

make demo

And visit http://localhost:8001/login to do oauth login.

Geofrey Ernest geofreyernest@live.com

Twitter : @gernesti

Facebook : Geofrey Ernest

The project osin is the foundation from which I got insight and direction of how oauth 2 works.

• Fix a lot of typos (English is my third language).
• implement the views templates( I need help here, I suck at styles)
• Support https.
• Add extensive documentation.
• Demo with examples.
• Let's encrypt integration.
• Add logging support.
• Templates hot reload.
• Livereload.
• XSRF protection.
• Flash messages.

This project is released under the MIT licence. See LICENCE for more details.