WEBDIENSTE/NLnetLabs-krill
1
0
Fork 0
mirror of https://github.com/NLnetLabs/krill.git synced 2026-09-20 08:27:49 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
27fd25dcb2aa6641cf58df979a3a5227d64cfffe
NLnetLabs-krill/test-resources/krill-init-multi-user.conf
T

888 lines
45 KiB
Plaintext
Raw Blame History

######################################################################################
# #
# DATA #
# #
######################################################################################
# Specify the directory where the publication server will store its data.
# Note that clustering through a shared data directory is not supported.
# But, we plan to look into a proper clustering solution later.
#
data_dir = "/var/lib/krill/data/"
# Specify the path to the PID file for Krill.
#
# Defaults to "krill.pid" under the 'data_dir' specified above.
#
### pid_file = "./data/krill.pid"
######################################################################################
# #
# LOGGING #
# #
######################################################################################
# Log level
#
# The maximum log level ("off", "error", "warn", "info", or "debug") for
# which to log messages.
#
# Defaults to "warn"
#
### log_level = "warn"
# Log type
#
# Where to log to. One of "stderr" for stderr, "syslog" for syslog, or "file"
# for a file. If "file" is given, the "log_file" field needs to be given, too.
#
### log_type = "file"
# Syslog facility
#
# The syslog facility to log to if syslog logging is used. Defaults to "daemon".
#
### syslog_facility = "daemon"
# Log file
#
# The path to the file to log to if file logging is used. If the path is
# relative, it is relative to the current working directory from which
# the binary is executed.
#
log_file = "/var/log/krill/krill.log"
######################################################################################
# #
# ACCESS #
# #
######################################################################################
# Admin Token
#
# Define an admin token that can be used to interact with the API. Token use
# is modelled after OAuth 2.0 Bearer Tokens (RFC 6750), which are expected be
# included as an HTTP header in requests by clients.
#
# If you do not specify a value here, the server will insist that you provide
# a token as an environment variable with the key "KRILL_ADMIN_TOKEN".
#
admin_token = "secret"
# Specify the ip address and port number that the server will use.
#
# Note: we recommend that you do NOT change the IP address to anything other
# than 127.0.0.1. Please use a proxy server such as NGINX or Apache if you
# must make your Krill instance accessible remotely.
#
# If you do change the IP address, then the service uri will use it as a hostname.
# If you want to use a proper public hostname, please set 'service_uri' below.
#
### ip = "127.0.0.1"
### port = 3000
# Specify the base public service URI hostname and port.
#
# The default service URI is set to https://localhost:3000/. This is fine for
# setups where you use Krill to run your own CA only. You do not need to set this
# to enable remote access to the UI or API (e.g. for using the CLI remotely).
# Simply setting up a proxy suffices for this.
#
# However, if you are serving as a parent CA or Publication Server that needs
# to be accessible by remote CAs, then you will need to tell your Krill instance
# what its public (base) URI will be, so that it can include the proper URIs
# in responses to those CAs.
#
# At present this MUST be an https URI with a hostname and optional port number only.
# It is not allowed to use a Krill specific path prefix. If you have a strong
# motivation for this, then please comment on the following github issue:
# https://github.com/NLnetLabs/krill/issues/263
#
# Krill UI, API and service URIs will be derived as follows:
# <service_uri>api/v1/... (api)
# <service_uri>rfc6492 (for remote children)
# <service_uri>... (various UI resources)
service_uri = "https://localhost:3001/"
######################################################################################
# #
# OTHER SEVER SETTINGS #
# #
######################################################################################
# CA certificate refresh rate
#
# This defines the rate, in seconds, for Krill CAs to to contact their parent CA
# via the RFC 6492 up-down protocol and query for updates in resource entitlements.
#
# Minimum value is 10 minutes, maximum is 60 minutes. Values below of this range
# are set to the minimum, values above this range are capped at the maximum.
#
# Defaults to 10 minutes
#
### ca_refresh_seconds = 600
# Enable loading BGP Dumps from RIS for ROA vs BGP analysis.
#
# bgp_risdumps_enabled = true
# bgp_risdump_v4_uri = http://www.ris.ripe.net/dumps/riswhoisdump.IPv4.gz
# bgp_risdump_v6_uri = http://www.ris.ripe.net/dumps/riswhoisdump.IPv6.gz
# Restrict size of messages sent to the API.
#
# Default 256 kB
#
### post_limit_api = 262144
# Restrict size of messages sent to the RFC 6492 up-down protocol. Only relevant
# if you operate Krill as a parent to other CAs.
#
# Default 1MB (enough for a keyroll with certs of ~400kb, the biggest known cert is 220kB)
#
### post_limit_rfc6492 = 1048576
######################################################################################
# #
# --------======== DANGER ZONE ========-------- #
# #
# Do not change the options below, unless you are really certain that you need to #
# override Krill's default behaviour. #
# #
######################################################################################
# Set the following to true to force Krill to always perform full rechecks
# of its data directories at startup. This is disabled by default because
# if can slow down startup significantly.
#
# By default Krill will do some basic checks at startup already, and if any
# errors are encountered force a full recovery automatically: Krill will try
# to load all its state in its internal memory cache at startup. If there are
# no errors in reloading the latest 'info' about the state, any surplus data
# will be assumed to be the result from an incompletely finished transaction - or -
# a data directory backup which was taken during a transaction. In either case
# additional data is discarded and the last (committed) state is recreated.
#
# Note that this 'recovery' will make Krill fall back to the last possible
# consistent state that it can. But, there may be important changes missing.
# For example any changes in ROAs made after the last recoverable state will
# be missing. You will have to verify the state yourself.
#
# In short: use this option only if you suspect that there is an issue with
# your backed up data. And if you do, you may want to set the ENV variable
# "KRILL_UPGRADE_ONLY" as well, in order to force that Krill exits after doing
# all its data checks and clean ups, and you have a chance to check the logs
# before proceeding.
#
### always_recover_data = false
#
# ROA Aggregation
#
# It is recommended that separate ROAs are used for each authorized prefix, even
# though the RFC allows for multiple prefixes for the same ASN to be combined on
# a single ROA object. The reason for this is that the ROA will become invalid
# if any of the listed prefixes no longer appears on your CA's certificate. Note
# that Krill will automatically clean up over-claiming ROAs when it finds that its
# resources have been shrunk, but there is a possible time window where ROAs can
# be invalid before Krill discovers the shrinkage.
#
# That said, if there would be too many ROAs then this will impact all RPKI
# validators, therefore Krill will by default start aggregating ROAs per ASN
# when more than 100 ROAs would be issued. Conversely, Krill will start de-
# aggregating again when the number of authorizations drops below 90.
#
# This behaviour can be overridden with the following directives:
# roa_aggregate_threshold = 100
# roa_deaggregate_threshold = 90
#
# Republication Intervals
#
# The RPKI uses Manifests (RFC 6486) to communicate the list of current RPKI
# objects (such as ROAs) to RPKI Validators. Manifests are used to protect against
# attacks, or incidents, where Validators only see a partial view of the RPKI
# repository. For this to work properly Validators will need to know how 'fresh'
# the Manifests are - otherwise they would be vulnerable to replay attacks where
# they are presented old versions of Manifests thus withholding them from discovering
# new RPKI objects.
#
#
# Krill issues manifests with a default next update and validity period of 24 hours.
# This means that the maximum replay window is 24 hours. Krill checks every 10 minutes
# whether the next update time is less then 8 hours (by default) in the future, and in
# that case it will re-issue them to avoid that Validators would end up with expired
# manifests. This means that an operator has a minimum of just under 8 hours to deal
# with issues with their CA or Publication Server before RPKI Validators would notice.
#
# The default values can be overridden, but with care.. make the next update interval
# too short and this causes too much work for all RPKI validators, puts load on your
# publication server and shortens your window to deal with issues. Make it too long
# and you could be vulnerable to replay attacks. Re-issue to quickly and again you
# cause extra load to RPKI validators and publication server.
#
# All that said.. if you are willing to accept the, in practice, small risk of a replay
# attack then you could for example opt for 48 hours next update and re-issue every
# 24 hours. That way you would have a full day to fix issues.
#
# timing_publish_next_hours = 24 # (must be 2 or higher)
# timing_publish_hours_before_next = 8 # (must be 1 or higher)
#
# ROA and Delegate Certificate Times
#
# Krill will issue ROAs, and child CA certificates if you have delegated resources
# to child CAs, with a "not after" time of 52 weeks from issuance, and it will
# re-issue those ROAs and certificates 4 weeks before they would expire.
#
# Because of the automatic renewal there should be no real need to use longer
# validity times. In fact using longer times could have a negative impact on
# Validator performance because the Certificate Revocation Lists would become
# bigger.
#
# So, we do NOT recommend overriding the following values, except perhaps for
# testing purposes:
# timing_child_certificate_valid_weeks = 52
# timing_child_certificate_reissue_weeks_before = 4
# timing_roa_valid_weeks = 52
# timing_roa_reissue_weeks_before = 4
#
# Suspend inactive child CAs
#
# NOTE: YOU DO NOT NEED THIS UNLESS YOU DELEGATE RESOURCES TO CHILD CAS
#
# If you delegate resources to child CAs, it may happen that those (remote)
# child CAs become inactive, most likely because the operator turned off
# their RPKI CA software.
#
# When this happens the manifest and CRL published by the child CA in
# question are no longer refreshed and expire fairly quickly. The exact
# timing depends on the RPKI CA software implementation and configuration.
# For Krill CAs using default configuration settings expiration will happen
# within 8 to 24 hours after shutdown because, by default, Krill CAs will
# use a 'next update' time of 24 hours after refresh, and pre-emptively
# refresh the CRL and manifest 8 hours before they would expire.
#
# Expired manifests and CRLs will lead to rejection of all of the child CA's
# RPKI objects. Note that this does not affect the validity of objects published
# by any other child CAs. Even though it is to be expected that this can happen in
# the RPKI, this rejection leads to logging by validation software, which in
# turn leads to concerns raised by network operators.
#
# The first responsibility for remediating this is with the operator of the
# child CA in question. They should fix their setup, or if they no longer wish
# to operate an RPKI CA then they should request that you remove them as a
# child and withdraw all their published objects.
#
# However, the operator may be unwilling or unreachable. In such cases the
# parent CA (you) may want to take it upon themselves to remove the child
# and thus quell this source of errors being reported to network operators
# around the globe. The trouble with this is, that if the child CA is then
# re-activated later they will no longer be listed as your child, but they
# do not know this. Their CA will simply get errors when trying to sync with
# you (their parent). Meaning, in order to fix this they would most likely
# need to remove you as a parent first and then re-do the initial XML exchange
# to get themselves set up as a child under you again.
#
# This is rather cumbersome. Therefore, we have added support for another
# approach. Rather than removing inactive child CAs, Krill can 'suspend' them
# instead. When a child CA is suspended all of its delegated certificates are
# removed from your CA's publication point. This means that RPKI validation
# software will no longer see these certificates, or any of the objects published
# under the child CA. The effect on validated objects is the same as when the
# the child CA's publication point would be rejected due to an expired manifest
# or CRL, except that errors are no longer being reported.
#
# If the child CA then becomes active again, it can simply be 'unsuspended'.
# Meaning, its certificates will be published again - as long as they are not
# expired and do not contain resources no longer held by the child. And then
# the child can resume its normal certificate request cycle with you as their
# parent without the need to re-do the parent-child exchanges.
#
# Trouble is that there is no clear cut way for a parent to know that
# a child CA had been deactivated. The best indication we have is by looking
# at the last attempt by the child to send an RFC 6492 request to a parent. By
# default Krill CAs will send an RFC 6492 list query every 10 minutes. So, if
# you did not receive any such query for more than this time, then it is likely
# the CA in question is no longer active.
#
# You can now configure Krill to automatically suspend child CAs for which
# no list query was received for longer than 'X' hours. The child is then
# automatically 'unsuspended' as soon as its sends another query.
#
# NOTE: By default Krill will NOT suspend children. This behaviour is only
# activated if the configuration directive below is set.
#
# Some outages are to be expected, and people may also change their configuration
# to send these queries less frequently. As mentioned earlier for Krill CAs
# an outage up to 8 hours will not result in any expired manifest or CRL issues.
# Therefore we recommend that you do not use any value lower than 8 for this
# directive:
#
# suspend_child_after_inactive_hours = 8
######################################################################################
# #
# ----==== WEB UI MULTI-USER LOGIN CONFIGURATION ====---- #
# #
# The settings below can be used to permit multiple users with configurable #
# access rights to login to the Krill web interface. #
# #
######################################################################################
#
# Global auth(entication & authorization) settings
#
# These control which auth provider in Krill will be used to authenticate users
# and settings common to all auth providers. See below for more details.
#
# auth_type = "admin-token"
# auth_policies = ["...", ...]
# auth_private_attributes = ["...", ...]
# Auth type (optional)
#
# Which provider to use for authentication (AuthN), authorization (AuthZ) and
# identity (ID). Also affects which login form the Krill web UI displays, or
# (in the case of auth_type = "openid-connect") the user is redirected to.
#
# Supported values: "admin-token" (default), "config-file" or "openid-connect".
#
# At-a-glance comparison:
# =======================
# Setting Value AuthN AuthZ ID
# ----------------------------------------------------------------------------
# "admin-token" admin_token role = "admin" id = "admin-token"
# ----------------------------------------------------------------------------
# "openid-connect" provider provider provider
# checked supplied supplied
# ----------------------------------------------------------------------------
# "config-file" values are taken from the [auth_users] section in this
# config file
# ----------------------------------------------------------------------------
#
# NOTE: At present the admin-token provider is used as a fallback provider
# when using "openid-connect" or "config-file" as the primary provider. This is
# to ensure that krillc, which uses admin-token authentication, is still able
# to communicate with the krill daemon.
#
### auth_type = "admin-token"
# Auth policies (optional)
#
# One or more paths to external authorization policy files to use in addition to
# those built-in to Krill. The files must be in Oso Polar format [*1] and are
# loaded after the built-in Krill policies.
#
# Custom authorization policies are intended to handle requirements that are too
# complex for just the settings available in krill.conf and is an advanced
# topic beyond the scope of this documentation.
#
# The built-in policies treat the following user attributes specially:
#
# - "role" - One of "admin", "readwrite" or "readonly". See the full Krill
# documentation for more information about which permissions are
# associated with each role.
# - "inc_cas" - A comma-separated set of CA handles which should be included
# in the set the user is permitted to see. If present this
# attribute will prevent the user seeing or interacting with any
# CA handle that is not in this set.
# - "exc_cas" - A comma-separated set of CA handles which should be excluded
# from the set the user is permitted to see. Overrides inc_cas.
# If inc_cas is not set, any CA handle NOT in exc_cas will be
# visible to the user who may interact with it according to
# the permissions granted to the user (e.g. through a role
# assignment).
#
# Note: The inc_cas and exc_cas settings only restrict visibility of and
# interaction with specified CAs via the Krill web UI. CA handles are still
# visible in the repository content and metrics output by Krill.
#
# References:
# *1 - https://docs.osohq.com/getting-started/policies/index.html
#
### auth_policies = ["...", ...]
# Auth private attributes (optional)
#
# Zero or more user attributes that should not be revealed by (or even sent to)
# the Krill web UI. For example, you may wish to hide "exc_cas" so that a user
# doesn't know which CAs they are prevented from seeing!
#
### auth_private_attributes = ["...", ...]
# Config File auth provider details (mandatory when auth_type = "config-file")
#
# The Config File auth provider allows you to define one or more users which can
# then be used to login to the Krill web UI.
#
# Example:
# auth_type = "config-file"
#
# [auth_users]
# "joe@example.com" = { attributes={ role="admin", exc_cas="ca1" }, password_hash="...", salt="..." }
#
# Syntax:
# auth_users = { "some id" = { ... } [, "another id" = { ... }, ...] }
#
# Alternative syntax:
# [auth_users]
# "some id" = { ... }
# "another id" = { ... }
#
# Where { ... } can contain the following fields:
#
# Field Mandatory? Notes
# ----------------------------------------------------------------------------
# id Yes Email address or other identifier for the user.
# To be entered in the username form field in the
# web UI when logging in. Also shown in the Krill
# event history as the actor to which the action is
# attributed.
#
# password_hash Yes Generate these values using the 'krillc config user'
# salt Yes command on the command line. The web UI will hash
# the password entered in the login form and submit
# it to Krill for comparison to this hash, thereby
# ensuring that passwords are neither transmitted
# nor persisted. Per password salts prevents use of
# rainbow table attacks. Dual salting prevents use of
# stolen password hashes from the config file being
# used to login without knowing the passwords.
#
# attributes No Zero or more key=value pairs, e.g. role="admin".
# The built-in authorization policy (see above)
# requires a role attribute with value "admin",
# "readonly" or "readwrite". Attribute key=value
# pairs may be displayed by the Krill web UI. To
# prevent attributes being sent to the UI, use the
# auth_private_attributes setting (see above).
#
### auth_type = "config-file"
###
### [auth_users]
### ...
# OpenID Connect auth provider details (mandatory when auth_type = "openid-connect")
#
# The OpenID Connect auth provider delegates authentication of users to an
# external provider that implements the OpenID Connect Core 1.0 specification.
# It can also optionally retrieve user attributes (known as "claims" [*1]) from
# the provider, or from an [auth_users] section in the Krill configuration file.
#
# Syntax:
# auth_openidconnect = { issuer_url="...", client_id="...", client_secret="..." }
#
# Alternative syntax:
# [auth_openidconnect]
# issuer_url = "..."
# client_id = "..."
# client_secret = "..."
# insecure = false
# extra_login_scopes = ["...", ...]
# extra_login_params = ["...", ...]
# prompt_for_login = false
# logout_url = "..."
#
# [auth_openidconnect.claims]
# ...
#
# Where { ... } can contain the following fields:
#
# (Sub)Field Mandatory? Notes
# ----------------------------------------------------------------------------
# issuer_url Yes Provided by your OpenID Connect provider. This is
# the URL of the OpenID Connect provider discovery
# endpoint. "/.well-known/openid_configuration"
# will be appended if not present. Krill will fetch
# the OpenID Connect Discovery 1.0 compliant JSON
# response from this URL when Krill starts up. If
# this URL does not match the "issuer" value in the
# discovery endpoint response or if the discovery
# endpoint cannot be contacted, Krill will fail to
# start.
#
# client_id Yes Provided by your OpenID Connect provider.
#
# client_secret Yes Provided by your OpenID Connect provider.
#
# insecure No Defaults to false. Setting this to true will
# disable verification of the signature of the
# OpenID Connect provider token ID endpoint
# response. Setting this to false may allow attackers
# to modify responses from the provider without
# being detected. Setting this to false is strongly
# discouraged.
#
# extra_login_scopes No Provider specific. Defaults to "". A
# comma-separated list of OAuth 2.0 scopes to be
# passed to the provider when a user is directed to
# login with the provider. Scopes are typically
# used to instruct the provider to send additional
# user details along with provider token responses.
# One common scope is "profile" which often causes
# the server to respond with email addresses and
# other personal details about the user. If the
# OpenID Connect provider discovery endpoint shows
# that "email" is a supported scope then the "email"
# scope will be requested automatically, you don't
# need to specify it here in that case.
#
# extra_login_params No A { key=value, ... } map of additional HTTP query
# parameters to send with the authorization request
# to the provider when redirecting the user to the
# OpenID Connect provider login form. Section
# 3.1.2.1. Authentication Request in the OpenID
# Connect Core 1.0 specification [*2] lists various
# parameters that can be sent but the supported set
# varies by provider. The prompt=login parameter is
# automatically sent by the provider (though this
# behavior can be disabled, see prompt_for_login
# below) and thus does not need to be provided
# using this setting. Can also be specified as a
# separate TOML table, e.g.:
#
# [openid_connect.extra_login_params]
# display=popup
# ui_locales="fr-CA fr en"
#
# prompt_for_login No Defaults to true. Setting this to false will
# disable the default behaviour of sending the
# prompt=login parameter to the provider. This
# also allows a different prompt=<value> to be
# specified using extra_login_params, from the set
# defined in Section 3.1.2.1. Authentication
# Request in the OpenID Connect Core 1.0
# specification [*2]: "none", "login", "consent"
# or "select_account".
#
# logout_url No A URL to direct the browser to redirect the user
# to in order to logout. Ideally this is not needed
# as the provider OpenID Connect Discovery response
# should contain the details Krill needs, but for
# some providers a logout_url must be specified
# explicitly. If the provider discovery response
# doesn't announce support for any supported
# mechanisms and no logout_url value is set then
# Krill will default to directing the user back to
# the Krill UI index page from where the user will
# be directed to login again via the OpenID Connect
# provider.
#
# claims No A { <claim>={...}, ... } map used to extract and
# +-- source No optionally transform claim values from the OpenID
# +-- jmespath Yes Connect provider responses [*3, *4]. Each claim
# +-- dest No specification results in zero or one additional
# attribute name=value pairs that can be shown
# in the Krill web UI and can be tested by the
# authorization policy.. Can also be specified as
# a separate TOML table, e.g.:
#
# [openid_connect.claims]
# name = { source="...", jmespath="...", dest="..."}
# name2 = { ... }
#
# An "id" claim is required. If not specified the
# following default "id" claim configuration will
# be used:
#
# id = { jmespath="email" }
#
# To prevent attributes being sent to the UI, use
# the auth_private_attributes setting (see above).
#
# source If the 'source' subfield is not provided, all
# available token and userinfo claim responses from
# the OpenID Connect provider will be searched for
# a field that matches the 'jmespath' expression.
#
# If specified the value identifies a specific
# claim set to search and can be one of the
# following values:
#
# config-file
# id-token-standard-claim
# id-token-additional-claim
# user-info-standard-claim
# user-info-additional-claim
#
# The source = "config-file" value is special, it
# doesn't refer to an OpenID Connect provider
# response claim set but rather to user attributes
# looked up using the "id" claim value as a key to
# index into the [auth_users] user attribute map.
#
# The "id" claim value cannot therefore itself be
# taken from [auth_users], and password_hash values
# in [auth_users] are ignored as authentication is
# handled by the OpenID Connect provider.
#
# dest The optional "dest" field can be used to set the
# value of an attribute by a different name than
# the claims key used. This can be used to specify
# multiple claim rules that attempt to extract a
# a value for the same claim. The first matching
# rule in such cases will be used.
#
# jmespath The "jmespath" field specifies a JMESPath [*5]
# expression which is used to find a matching field
# in the OpenID Connect provider JSON response. In
# addition to the standard JMESPath functions the
# Krill implementation includes two custom regular
# expression based functions to match and
# optionally replace parts of the value of the
# fieldm matched by the JMESPath expression. These
# two functions are:
#
# recap(<field name/value>, 'capturing regex')
# resub(<field name/value>, 'search regex', replace'))
#
# With these extra functions cases where part of a
# complex string should be matched, extacted and
# (with resub) mapped to a value that matches what
# the authorization policy expects. E.g. it could
# be used to match a substring and then to "output"
# a particular Krill role name.
#
# If the combination of "resub()" and "dest" is
# not powerful enough you can take value matching
# even further using policy file rules. "dest" and
# "resub" may be combined with policy file rules in
# order to simplify the policy file rules needed.
#
# When determining the right "jmespath" expression
# to use, match failures will be logged at "info"
# level (as the auth policy in use may not require
# all configured claims to be found for all users)
# including a list of claims that are available to
# match. Additionally at "debug" level details
# about the claim search process are logged and at
# "trace" level the OpenID HTTP Connect provider
# HTTP/JSON responses are logged.
#
# Escaping: If you need to use double quotes to
# escape a JMESPath identifier you will need to use
# jmespath='...' or jmespath='''...''' instead of
# jmespath="..." in the Krill configuration file.
# See the JMESPath [*6] and TOML [*7] specs for
# more information about quoting and escaping.
#
# References:
# *1: https://openid.net/specs/openid-connect-core-1_0.html#Claims
# *2: https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
# *3: https://openid.net/specs/openid-connect-core-1_0.html#TokenResponse
# *4: https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse
# *5: https://jmespath.org/
# *6: https://jmespath.org/specification.html#identifiers
# *7: https://toml.io/en/v1.0.0#string
#
# ------------------------------------------------------------------------------
# Registering Krill with an OpenID Connect provider:
# ------------------------------------------------------------------------------
# In order to communicate with an OpenID Connect provider, Krill must first be
# registered with that provider. As a result of registration you will be issued
# a client_id and a client_secret, and possibly also an issuer_url (or you may
# have to consult the provider documentation to determine the issuer_url).
#
# When registering you will usually need to specify a callback URL. For Krill
# this should be <service_uri>auth/callback (replace <service_uri> with the
# actual value set above).
#
# When auth_type = "openid-connect" the client details MUST be provided to Krill
# via settings in the [auth_openidconnect] section of the configuration file.
#
# ------------------------------------------------------------------------------
# Required OpenID Connect provider capabilities:
# ------------------------------------------------------------------------------
#
# The OpenID Connect provider must implement the following specifications:
#
# https://openid.net/specs/openid-connect-core-1_0.html
# https://openid.net/specs/openid-connect-discovery-1_0.html
# https://openid.net/specs/openid-connect-rpinitiated-1_0.html
#
# At the issuer_url endpoint the provider MUST announce support for at least the
# following:
#
# "issuer": ".."
# "authorization_endpoint": "..",
# "token_endpoint": "..", ("userinfo_endpoint" is also supported if available)
# "jkws_uri": "..",
# "scopes_supported": ["openid"]
# "response_types_supported": ["code"]
# "response_modes_supported": ["query"]
# "grant_types_supported": ["authorization_code"]
# "id_token_signing_alg_values_supported": ["RS256"]
# one of: "end_session_endpoint": ".." or "revocation_endpoint": ".."
#
# ------------------------------------------------------------------------------
# A note about HTTPS certificates:
# ------------------------------------------------------------------------------
# If the provider URLS are HTTPS URLs (which they should be unless this
# deployment of Krill is only for testing) then the HTTPS certificate must have
# been issued by a CA in the O/S CA certificate store, i.e. either a well known
# authority that is included in the store by default, or a custom CA that you
# have added to the store yourself. Krill will fail to connect to a provider
# that uses a self-signed certificate or a certificate from an unknown root
# certificate authority. For more information see for example:
# http://manpages.ubuntu.com/manpages/xenial/man8/update-ca-certificates.8.html
# ------------------------------------------------------------------------------
#
# ------------------------------------------------------------------------------
# A note about end_session_endpoint and revocation_endpoint:
# ------------------------------------------------------------------------------
# "end_session_endpoint" is defined by various [*1] OpenID Connect draft
# specifications relating to logout. In Krill it is used for the purpose defined
# in the OpenID Connect RP-Initiated Logout 1.0 spec [*1], namely for Krill as
# the RP (OpenID Connect terms Krill a Relying Party in this context, which is
# particularly confusing given that the term Relying Party also has meaning in
# Krill's native RPKI domain) to be able to initiate logout of the user at the
# provider. Krill also requires that the endpoint either honours the
# "post_logout_redirect_uri" HTTP query parameter (defined as OPTIONAL in the
# spec) or that the provider can be configured with corresponding behaviour,
# i.e. to redirect the end-user user-agent (browser) back to Krill after logout
# is completed at the provider. If support for this is lacking it is undefined
# where the user will end up after logout, which is not an issue if the user
# was finished with Krill, but is annoying if the logout was done in order to
# re-login to Krill as a different user. At least one provider has been observed
# which does NOT support this endpoint.
#
# As an alternative Krill also supports "revocation_endpoint"
# (see https://tools.ietf.org/html/rfc7009 "OAuth 2.0 Token Revocation") which
# is used to terminate the users login session at the provider without leaving
# the Krill web UI.
#
# Finally if neither of these mechanisms are supported a logout_url can be
# specified explicitly via configuration.
#
# References:
# *1: https://openid.net/specs/openid-connect-session-1_0.html
# *2: https://openid.net/specs/openid-connect-rpinitiated-1_0.html
# *3: https://tools.ietf.org/html/rfc7009
#
# ------------------------------------------------------------------------------
# Example RedHat KeyCloak configuration:
# ------------------------------------------------------------------------------
# This example is for a local test deployment of RedHat KeyCloak:
#
# [auth_openidconnect]
# issuer_url = "http://localhost:8082/auth/realms/myrealm"
# client_id = "krill"
# client_secret = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
#
# That's it! For this to work you must already have configured your KeyCloak
# instance e.g. with a realm, client (with redirect URI set), users and an
# attribute mapper (to expose a custom user attribute as a "role" claim) and a
# "role" attribute for each user.
#
# ------------------------------------------------------------------------------
# Example Azure Active Directory configuration:
# ------------------------------------------------------------------------------
# This example is for a Microsoft Azure cloud Active Directory instance that
# permits only read-only and read-write access to users that login via the Krill
# web UI:
#
# [auth_openidconnect]
# issuer_url = "https://login.microsoftonline.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/v2.0"
# client_id = "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
# client_secret = "zzzzzzzz"
# extra_login_scopes = ["offline_access"]
#
# [auth_openidconnect.claims]
# id = { jmespath="name" }
# ro_role = { jmespath="resub(roles[?@ == 'gggggggg-gggg-gggg-gggg-gggggggggggg'] | [0], '^.+$', 'readonly')", dest="role" }
# rw_role = { jmespath="resub(roles[?@ == 'hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh'] | [0], '^.+$', 'readwrite')", dest="role" }
#
# For this to work you must already have configured in the Azure portal your AD
# tenant, app registration and enterprise application settings (with redirect
# URI), users, group assignments and optional claim configuration (in the above
# example AD was configured to expose groups as roles).
#
# The JMESPath expression matches on Azure AD group GUID values, taking the
# first match it finds and then setting the "role" attribute to either readonly
# or readwrite depending on which GUID was matched. The GUIDs for your groups
# will be different than those used in this example, see your Krill log for the
# GUIDs to match on.
#
# The offline_access scope is required in order to trigger Azure Active
# Directory to issue a refresh token to Krill.
#
# ------------------------------------------------------------------------------
# Example Amazon Web Services Cognito configuration:
# ------------------------------------------------------------------------------
# [auth_openidconnect]
# issuer_url = "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_xxxxxxx"
# client_id = "yyyyyyyy"
# client_secret = "zzzzzzzz"
# logout_url = "https://dddddddd.auth.eu-central-1.amazoncognito.com/logout?client_id=yyyyyyyy&logout_uri=https://your.krill.domain/"
#
# [auth_openidconnect.claims]
# role = { jmespath='''resub("cognito:groups"[?@ == 'KrillAdmins'] | [0], '^.+$', 'admin')''' }
#
# For this to work you must already have configured in the AWS Cognito console
# a group called KrillAdmins and have added the logging in user to that group.
# Otherwise the "cognito:groups" claim will not be present in the ID token
# response issued by AWS Cognito. You also need to have set a "Sign Out URL" for
# in your AWS Cognito "App client settings" which should match the value you
# use for the "logout_uri" query parameter in the logout_url Krill setting.
#
# logout_url needs to be set because AWS Cognito doesn't advertise support for
# any of the OpenID Connect logout mechanisms that Krill understands.
#
# dddddddd should be replaced by your AWS Cognito domain prefix that you
# specified in hte AWS Cognito "App integration" -> "Domain name" console
# setting. The regions in the URLs should also match those that you are using.
#
# Note the use of ''' which is needed because the Cognito groups claim contains
# a colon which is a reserved character in JMESPath identifiers.
#
# ------------------------------------------------------------------------------
# Example Google Cloud Platform configuration:
# ------------------------------------------------------------------------------
# [auth_openidconnect]
# issuer_url = "https://accounts.google.com/.well-known/openid-configuration"
# client_id = "xxxxxxxx.apps.googleusercontent.com"
# client_secret = "yyyyyyyy"
# extra_login_scopes = ["profile"]
#
# [auth_openidconnect.claims]
# role = { jmespath='''recap(resub(picture, '^.+photo\.jpg$', 'admin'), '(admin)')''' }
#
# For this to work you must already have created Credentials in the Google
# developer console and have set the redirect URI to your Krill API
# /auth/callback public URL.
#
# In this example we have included the ".well-known/..." part of the issuer_url
# to demonstrate that Krill will accept the URL with or without it.
#
# ''' is used to ensure that characters in the regular expression don't conflict
# with JMESPath reserved characters. The JMESPath expression in this example is
# not a useful real world example as it grants "admin" rights to any Google
# account that has an associated picture whose URL ends in photo.jpg.
#
# The JMESPath expression in this example uses an outer recap() call to sanity
# check that the resulting role value is what we expect it to be. Without this
# a URL that doesn't match would pass straight through resub() unchanged. The
# recap() check is needed because you might use resub() to "clean up" values
# that in some cases don't need any cleaning and thus would still be wanted
# even though not modified.
#
# Also note that, while not visible in the configuration above, the GCP OpenID
# Connect provider advertizes an RFC 7009 OAuth 2.0 Token Revocation compatible
# `revocation_endpoint` which Krill will use to revoke the Google login token
# when the user logs out of Krill.
Reference in New Issue View Git Blame Copy Permalink