go-session-auth-template

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #android #machine-learning #awesome #cli #kubernetes #awesome-list #pytorch #ios #openai #open-source

go-session-auth-template

(★ 9)

A demo app server written in golang that implements cookie session based authentication.

go-session-auth-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Demo Auth-Server in Golang

This repo demonstrates how you can implement cookie session based Authentication in Golang. This codebase uses:

- [chi](https://github.com/go-chi/chi) (router)
- [scs](https://github.com/alexedwards/scs) (sessions)
- [Badger](https://github.com/dgraph-io/badger) (data store)

## Folder Structure

- `handlers`: Contains all handlers, and two functions to create easily uniformed responses.
- `middleware`: Contains all middlewares, and a custom type to help creating configurable middlewares.
- `models`: Contains structs that provide access to the data store.
- `server`: Contains the starting point of the application and all basic setup logic.
- `services`: Contains additional helper logic and stuff like wrapper functions.
- `values`: Contains simple values like identifiers and global keys that are needed around the app.

## Try it out

On Linux/Unix:

~~~ bash
go build
./auth-server
~~~

On Windows:

~~~ powershell
go build
auth-server.exe
~~~

There's also a Makefile that does just that (only on Windows). If you can use the Makefile, you could instead just type:

~~~ bash
make
~~~

## HTTP Responses

For a **successful request** you get a response like this:

~~~json
{
	"status": "ok",
	"data": ...
}
~~~

- `status` will always be `"ok"`.
- `data` can be any type, depending on the request. If there's no data to put in the response it's omited altogether.

For **requests that lead to any kind of error** you get a response like this:

~~~json
{
	"status": "error",
	"message": "...",
	"details": "..."
}
~~~

- `status` will always be `"error"`.
- `message` will contain a custom message that tells you more about what has happened. This is for debugging purposes only. To check for the error in your client code, please consult the HTTP status code.
- `details` is the content of any `err` variable if one is involved. If not, `details` is omited.

## Routes

### `GET /`

Test, if the server is running. The response should be:

~~~ json
{
    "data": "Demo Auth Server is running.",
    "status": "ok"
}
~~~

### `GET /db`

A route for debugging purposes. It returns all values stored in the Badger store.

### `GET /user/{email}`

Once you added a user you can fetch its data from the data store using this route.

### `GET /profile`

If you're signed in it returns your user name. Otherwise it tells you that you're not signed in.

### `GET /public`

This should return a JSON in any case. Similar to `GET /`.

### `GET /secret`

This should only return a JSON once you're signed in. Otherwise it returns a `403` status.

### `POST /auth/signup`

Adds a user to the data store. The password gets hashed and salted using `bcrypt`.

**Request body**:

~~~ json
{
	"email": "john@doe.com",
	"password": "secret-password",
	"password_confirm": "secret-password"
}
~~~

### `POST /auth/signin`

Signs in the user. Creates a session and adds a session cookie to the response. Currently the sessions are stored in-memory because `scs` doesn't support Badger yet.

**Request body**:

~~~ json
{
	"email": "john@doe.com",
	"password": "secret-password"
}
~~~

### `POST /auth/signout`

Deletes the session, and so the user gets signed out.

## Database

This demo uses [BadgerDB](https://github.com/dgraph-io/badger) to store all kinds of values. The following keys are being used:

| Key schema | Value description |
| ---------- | ----------------- |
| `user:<id>:email` | Contains the user's e-mail address |
| `user:<id>:password` | Contains the user's hashed password |
| `user:seq` | Contains the BadgerDB sequence for creating new user IDs |
| `user:email:<e-mail>` | Contains the user ID. This is used to fetch a user by it's e-mail address |
| `session:<session-id>` | Contains (scs) session data |

go-session-auth-template

go-session-auth-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

go-session-auth-template

go-session-auth-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README