Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanoninja/bulma
Implementation of Basic HTTP authentication middleware for Go language.
https://github.com/nanoninja/bulma
auth authentication basic bulma go godev godoc golang handler http middleware module package
Last synced: 3 months ago
JSON representation
Implementation of Basic HTTP authentication middleware for Go language.
- Host: GitHub
- URL: https://github.com/nanoninja/bulma
- Owner: nanoninja
- License: bsd-3-clause
- Created: 2016-08-11T15:22:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-20T16:55:41.000Z (over 4 years ago)
- Last Synced: 2024-06-20T11:46:04.089Z (8 months ago)
- Topics: auth, authentication, basic, bulma, go, godev, godoc, golang, handler, http, middleware, module, package
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bulma
Basic authentication implementation for Go.
[](https://golang.org/) [](https://github.com/nanoninja/bulma/blob/master/LICENSE) [](https://github.com/nanoninja/bulma/tags)
[](https://pkg.go.dev/github.com/nanoninja/bulma?tab=doc) [](https://travis-ci.org/nanoninja/bulma) [](https://coveralls.io/github/nanoninja/bulma?branch=master) [](https://goreportcard.com/report/github.com/nanoninja/bulma) [](https://codebeat.co/projects/github-com-nanoninja-bulma)
## Installation
```sh
go get github.com/nanoninja/bulma
```
## Getting started
After installing Go and setting up your
[GOPATH](http://golang.org/doc/code.html#GOPATH), create your first `.go` file.
```go
package main
import (
"fmt"
"net/http"
"github.com/nanoninja/bulma"
)
func main() {
onSuccess := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Dashboard")
})
ba := bulma.BasicAuth(bulma.Realm, onSuccess, bulma.User{
"foo": "bar",
"bar": "foo",
})
http.Handle("/admin", ba)
http.ListenAndServe(":3000", nil)
}
```
## Using a function as validator
```go
func main() {
onSuccess := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Dashboard")
})
validator := bulma.ValidateFunc(func(c *bulma.Credential) bool {
return c.Authorization && c.Username == "foo" && c.Password == "bar"
})
ba := bulma.BasicAuth(bulma.Realm, onSuccess, validator)
http.Handle("/admin", ba)
http.ListenAndServe(":3000", nil)
}
```
## Using configuration
The configuration allows you to set up HTTP authentication.
```go
type Config struct {
Realm string
Validator Validator
Success http.Handler
Error http.Handler
}
```
Example :
```go
func main() {
onSuccess := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Dashboard")
})
onError := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "My Custom Error Handler")
})
ba := bulma.New(&bulma.Config{
Realm: "MyRealm",
Validator: bulma.Auth("foo", "bar"),
Success: onSuccess,
Error: onError,
})
http.Handle("/admin", ba)
http.ListenAndServe(":3000", nil)
}
```
## Creating Validator
To create a validator, use bulma.Validator interface.
```go
type Validator interface {
Validate(*Credential) bool
}
```
Example :
```go
type MyValidator struct {
username, password string
}
func (v MyValidator) Validate(c *bulma.Credential) bool {
return c.Authorization && v.username == c.Username && v.password == c.Password
}
```
Using your own validator
```go
func main() {
onSuccess := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Dashboard")
})
ba := bulma.BasicAuth("MyRealm", onSuccess, MyValidator{"foo", "bar"})
http.Handle("/admin", ba)
http.ListenAndServe(":3000", nil)
}
```
## License
Bulma is licensed under the Creative Commons Attribution 3.0 License, and code is licensed under a [BSD license](https://github.com/nanoninja/bulma/blob/master/LICENSE).