Authentication server providing tokens for users. Usable by all libIPC services.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Philippe Pittoli 1f2f72fba8 Add a makefile. 1 week ago
spec Very basic initial spec. 4 years ago
src Authd now uses '-k' instead of '-K' (like other services). 4 months ago
.gitignore git ignore 3 years ago Authd now uses '-k' instead of '-K' (like other services). 4 months ago
db-password-file initial commit 5 years ago
makefile Add a makefile. 1 week ago
project.zsh Removed unused build targets. 3 years ago
shard.yml New file structure: authd can now be used as a simple library. 4 months ago


authd is a token-based authentication micro-service.


authd is written in Crystal and uses build.zsh as Makefile generator, as well as shards to fetch dependencies.

You’ll need the following tools to build authd:

  • crystal
  • shards
  • build.zsh
  • make

To build authd, run the following commands:

shards install

Note that if you clone authd from its repository, its Makefile may be missing. In such situations, run build.zsh -c to generate it, after which make should run fine.


$ authd --help
usage: authd [options]
    -s directory, --storage directory
                                     Directory in which to store users.
    -k file, --key-file file         JWT key file
    -R                               --allow-registrations
    -h, --help                       Show this help

Users storage

The storage directory will default to ./storage.

No SQL database, database management system or other kind of setup is required to run authd and store users.

To migrate an instance of authd, a simple copy of the storage directory will be enough. Make sure your copy preserves symlinks, as those are extensively used.

Administrating users

The authd-user-add and authd-user-allow are tools to add users to authd’s database and to edit their permissions.

The permission level none can be used in authd-user-allow to remove a permission.

Key file

authd will provide users with cryptographically signed tokens. To sign and check those tokens, a shared key is required between authd and services using authd.

authd reads that key from a file to prevent it being visible on the command line when running authd.

Any content is acceptable as a key file.


$ echo "I am a key." > key-file
$ authd -k ./key-file



authd’s protocol is still subject to change.


A AuthD::Client Crystal class is available to build synchronous clients in Crystal.

require "authd"

authd =
authd.key ="./some-file").chomp

pp! r = authd.get_token?("login", "password")

pp! r = authd.add_user("login", "password")

pp! u = authd.get_user?("login", "password").not_nil!


Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.