About
STOPnik is a small, fast and secure authorization server with an minimal amount of dependencies.
Dependencies
Currently, STOPnik only depends on
- github.com/lestrrat-go/jwx/v4 v4.6.0 (handle JWT, JWK, JWE, etc…)
- gopkg.in/yaml.v3 v3.0.1 (parse YAML files)
Development tools
For development, STOPnik uses golangci-lint v2.15.0 to lint the code (make lint).
It is registered as a Go tool dependency via the tool directive and runs with go tool golangci-lint.
Because of this, the go.mod file lists many indirect dependencies.
They are only needed by golangci-lint and are not compiled into the STOPnik binary.
Related specifications
Why STOPnik exists?
In general this project was started to learn OAuth2, OpenId Connect and Go. Furthermore, it was also created to be used in a Homelab and VPS to replace the current Keycloak, which adds too much load to the VPS and has to many configuration possibilities.
STOPnik does not have any persistence layer and will only work in-memory with the clients and users defined in the
configuration file (YAML).
When restarted, all issued tokens will become invalid/forgotten by STOPnik.
You still may consider using another authorization server.
STOPnik alternatives
The awesome work of other servers is very appreciated, most of them were the inspiration for this small project! ♥️
They add features like persistence and access to user directories like LDAP.