cis-idm

cisidm: Simple Self-Hosted Identity-Management Server

Welcome to the project page of cisidm, a simple, self-hosted and high-available identity management server.

Please note that cisidm is being actively developed and is not yet complete or ready for production use. Use at your own risk!

Features

• Protobuf defined API using Connect for interoperability with browsers and gRPC.
• Support for 2FA using TOTP with Recovery Codes
• Support for WebAuthN and Passkeys
• A public listener (which requires authentication)
• A admin/internal listener for un-authenticated use by other micro-services
• Privacy (access to user profile fields) backed into Protobuf (see tierklinik-dobersberg/apis)
• Stateless (uses rqlite for storage) so it can be deployed multiple times for load-balancing.
• Support user invites per mail
• A /validate endpoint that can be used for proxy forward authentication as supported in Traefik or Caddy.
• A pretty Self-Service Portal UI:
  • Update / Manage profile / avatar picture.
  • Change passwords or reset via mail link
  • Enroll 2FA (TOTP)
  • Enroll WebAuthN/Passkeys
  • Self registration (may optionally require a registration token) with either Password or WebAuthN
  • Manage E-Mail addresses and verify them
  • Manage phone numbers and verify them using one-time security codes.
  • Manage addresses (delivery/billing/...)
  • Dark and Light mode 🚀

Upcoming / Planned

The following features are on our roadmap and will be finished before cisidm will be released as a v1:

• Self-Service: Manage your active user-sessions and revoke refresh/access tokens
• UI: i18n support (UI is currently in German Only)
• Authz: A role based authentication system
• Self-Service: Change privacy settings
• Auth: 2FA authentication using SMS
• Auth: 2FA authentication using E-Mail
• Auth: E-Mail magic-link authentication
• Feature-Flag management on a per-user basis

Quick-Start

To quickly get up and running cisidm for testing purposes you can use the docker-compose.yml file to bring up cisidm a single rqlite node and Traefik (configured for self-signed certificates). Please make sure to update ./config.test.yml before to match your settings. Also, it is recommended to update your /etc/hosts so the domain names you use for testing will resolve to 127.0.0.1.

For example, given the following configuration file:

audience: example.dev
domain: example.dev
secureCookie: true
jwtSecret: some-secure-string
rqliteURL: http://rqlite:4001/
forwardAuth:
  - url: http(s){0,1}://wiki.example.dev
    required: true
allowedOrigins: 
  - http://example.dev
  - https://example.dev
publicURL: https://account.example.dev
allowedRedirects:
  - wiki.example.dev

twilio:
  sid: XXXX
  token: XXXX
  from: XXXX

mail:
  host: xxxx
  user: xxxx
  password: xxxx
  port: 465
  from: xxxx

You should make sure that example.dev, wiki.example.dev and account.example.dev resolve to localhost.

Finally, just launch:

docker-compose build && docker-compose up

A full reference of all available configuration keys can be found in ./internal/config/config.go.

Important Warning

For the time being cisidm depends on tierklinik-dobersberg/apis (for Go) and on '@tierklinik-dobersberg/apis' (for JS/TypeScript). These are not yet released! The Dockerfile provided in this repository expected a tkd/apis:latest image on your machine.

Just clone tierklinik-dobersberg/apis and execute docker build -t tkd/apis:latest . once before running docker-compose build from this repo.

This will likely be fixed in the next weeks.

Documentation

To be done.

Versioning

Since cisidm is still in early development it has not yet reached a stable API. While we try to avoid breaking changes please expect them to happen at this point!

Once we reach a final v1 the APIs will be frozen and not changed in backwards incompatible ways. Stay tuned ...

License

For now, this repository is licensed under MIT License. While this might be subject to change cis-idm will stay OSS but may start prohibiting unlicensed enterprise use.

Any such changes will be communicated and can be discussed beforehand on the Github Issue Tracker.