The Portier Broker reference implementation
How to run your own broker
Portier is specified such that everyone can run their own Broker instance. You can point your Relying Parties at your own broker, so that you do not have to depend on the broker run by the Portier project.
Currently, this project does not ship any binaries. However, once you have the Rust toolchain installed, building portier broker is very simple:
$ cargo install portier_broker
This should fetch and install the Portier broker. The binary is installed into
~/.cargo/bin/ by default. Running the portier-broker binary requires
a short configuration file. An example is provided in
To run the broker, invoke it with the path to a configuration file:
$ portier-broker config.toml
You can also supply all required settings as environment variables and completely omit the configuration file.
You will also need a Redis server and an outgoing SMTP server.
should be in the format
fields are optional, and may be set to provide login credentials.
config.toml.dist for an example configuration file. The available values
|static_ttl||BROKER_STATIC_TTL||604800 (1 week)|
|discovery_ttl||BROKER_DISCOVERY_TTL||604800 (1 week)|
|keys_ttl||BROKER_KEYS_TTL||86400 (1 day)|
|token_ttl||BROKER_TOKEN_TTL||600 (10 minutes)|
|keyfiles||BROKER_KEYFILES|| (empty array)|
|session_ttl||BROKER_SESSION_TTL||900 (15 minutes)|
|cache_ttl||BROKER_CACHE_TTL||3600 (1 hour)|
|cache_max_doc_size||BROKER_CACHE_MAX_DOC_SIZE||8096 (8 KiB)|
The example configuration file,
config.toml.dist, includes reasonable default
values for most settings, but you must explicitly set:
server.public_url: The server's public-facing URL.
crypto.keyfiles: An array of paths to encryption keys, or
crypto.keytext: The text of an encryption key in PEM format (takes precedence over keyfiles).
redis.url: The URL of a Redis server for temporary session storage.
smtp.from_address: The email address that outgoing mail is from.
smtp.server: The host and port of the outgoing mail server.
If necessary, set
smtp.password to your SMTP server's
username and password.
To support in-browser Google Authentication for Gmail users, you must also specify:
providers."gmail.com".client_id: Your Google OAuth API Client ID
providers."gmail.com".secret: Your Google OAuth API Secret Key
You can create encryption keys with
openssl genrsa 4096 > private.pem
If you want to hack on the broker code, clone this repository. If you have the
Rust toolchain installed (see above), you can run
cargo build to build the
project in debug mode.
cargo run <config-file> will run the project. You
will have to set up your own configuration file; use
as a template.
The broker binds to
127.0.0.1:3333 by default. It only speaks HTTP, so you
must run it behind a reverse proxy like nginx to expose it to the web via TLS.
Note that the broker will serve up files from the
in the current working directory when executed; this makes it relatively easy
to request a certificate from Let's Encrypt.
If you want to test support for well-known identity providers, you will need to configure them. For Google, you can request credentials through their API Manager.
It is not necessary to run your own email server for testing. Instead, use MailCatcher or MailHog to get a dummy SMTP interface. The relevant part of configuration to use MailCatcher with default settings can look like this:
[smtp] # Display name for confirmation emails - Default: "Portier" from_name = "Portier" # Sender address for confirmation emails - Default: (none) from_address = "firstname.lastname@example.org" # Outgoing mailserver address - Default: (none) server = "127.0.0.1:1025"
To test your changes, you will need to set up a Relying Party; so far, the Python demo-rp code has been used. This is a very bare-bones implementation that only serves to prove authentication to the broker.