# Barbican Sample Configuration File

Use the `barbican.conf` file to configure most Key Manager service options:

    [DEFAULT]

    #
    # From barbican.common.config
    #

    # Role used to identify an authenticated user as administrator.
    # (string value)
    #admin_role = admin

    # Allow unauthenticated users to access the API with read-only
    # privileges. This only applies when using ContextMiddleware. (boolean
    # value)
    #allow_anonymous_access = false

    # Maximum allowed http request size against the barbican-api. (integer
    # value)
    #max_allowed_request_size_in_bytes = 25000

    # Maximum allowed secret size in bytes. (integer value)
    #max_allowed_secret_in_bytes = 20000

    # Host name, for use in HATEOAS-style references. When unset the
    # endpoint is derived from wsgi request. (uri value)
    #
    # This option has a sample default set, which means that
    # its actual default value may vary from the one documented
    # below.
    #host_href = http://localhost:9311

    # Create the Barbican database on service startup. (boolean value)
    #db_auto_create = false

    # Maximum page size for the 'limit' paging URL parameter. (integer
    # value)
    #max_limit_paging = 100

    # Default page size for the 'limit' paging URL parameter. (integer
    # value)
    #default_limit_paging = 10

    # DEPRECATED: Accepts a class imported from the sqlalchemy.pool
    # module, and handles the details of building the pool for you. If
    # commented out, SQLAlchemy will select based on the database dialect.
    # Other options are QueuePool (for SQLAlchemy-managed connections) and
    # NullPool (to disabled SQLAlchemy management of connections). See
    # http://docs.sqlalchemy.org/en/latest/core/pooling.html for more
    # details (string value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: This option has been ineffective
    #sql_pool_class = QueuePool

    # Show SQLAlchemy pool-related debugging output in logs (sets DEBUG
    # log level output) if specified. (boolean value)
    #sql_pool_logging = false

    #
    # From cotyledon
    #

    # Enables or disables logging values of all registered options when
    # starting a service (at DEBUG level). (boolean value)
    # Note: This option can be changed without restarting.
    #log_options = true

    # Specify a timeout after which a gracefully shutdown server will
    # exit. Zero value means endless wait. (integer value)
    # Note: This option can be changed without restarting.
    #graceful_shutdown_timeout = 60

    #
    # From oslo.log
    #

    # If set to true, the logging level will be set to DEBUG instead of
    # the default INFO level. (boolean value)
    # Note: This option can be changed without restarting.
    #debug = false

    # The name of a logging configuration file. This file is appended to
    # any existing logging configuration files. For details about logging
    # configuration files, see the Python logging module documentation.
    # Note that when logging configuration files are used then all logging
    # configuration is set in the configuration file and other logging
    # configuration options are ignored (for example, log-date-format).
    # (string value)
    # Note: This option can be changed without restarting.
    # Deprecated group/name - [DEFAULT]/log_config
    #log_config_append = <None>

    # Defines the format string for %%(asctime)s in log records. Default:
    # %(default)s . This option is ignored if log_config_append is set.
    # (string value)
    #log_date_format = %Y-%m-%d %H:%M:%S

    # (Optional) Name of log file to send logging output to. If no default
    # is set, logging will go to stderr as defined by use_stderr. This
    # option is ignored if log_config_append is set. (string value)
    # Deprecated group/name - [DEFAULT]/logfile
    #log_file = <None>

    # (Optional) The base directory used for relative log_file  paths.
    # This option is ignored if log_config_append is set. (string value)
    # Deprecated group/name - [DEFAULT]/logdir
    #log_dir = <None>

    # Use syslog for logging. Existing syslog format is DEPRECATED and
    # will be changed later to honor RFC5424. This option is ignored if
    # log_config_append is set. (boolean value)
    #use_syslog = false

    # Enable journald for logging. If running in a systemd environment you
    # may wish to enable journal support. Doing so will use the journal
    # native protocol which includes structured metadata in addition to
    # log messages.This option is ignored if log_config_append is set.
    # (boolean value)
    #use_journal = false

    # Syslog facility to receive log lines. This option is ignored if
    # log_config_append is set. (string value)
    #syslog_log_facility = LOG_USER

    # Use JSON formatting for logging. This option is ignored if
    # log_config_append is set. (boolean value)
    #use_json = false

    # Log output to standard error. This option is ignored if
    # log_config_append is set. (boolean value)
    #use_stderr = false

    # (Optional) Set the 'color' key according to log levels. This option
    # takes effect only when logging to stderr or stdout is used. This
    # option is ignored if log_config_append is set. (boolean value)
    #log_color = false

    # The amount of time before the log files are rotated. This option is
    # ignored unless log_rotation_type is set to "interval". (integer
    # value)
    #log_rotate_interval = 1

    # Rotation interval type. The time of the last file change (or the
    # time when the service was started) is used when scheduling the next
    # rotation. (string value)
    # Possible values:
    # Seconds - <No description provided>
    # Minutes - <No description provided>
    # Hours - <No description provided>
    # Days - <No description provided>
    # Weekday - <No description provided>
    # Midnight - <No description provided>
    #log_rotate_interval_type = days

    # Maximum number of rotated log files. (integer value)
    #max_logfile_count = 30

    # Log file maximum size in MB. This option is ignored if
    # "log_rotation_type" is not set to "size". (integer value)
    #max_logfile_size_mb = 200

    # Log rotation type. (string value)
    # Possible values:
    # interval - Rotate logs at predefined time intervals.
    # size - Rotate logs once they reach a predefined size.
    # none - Do not rotate log files.
    #log_rotation_type = none

    # Format string to use for log messages with context. Used by
    # oslo_log.formatters.ContextFormatter (string value)
    #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

    # Format string to use for log messages when context is undefined.
    # Used by oslo_log.formatters.ContextFormatter (string value)
    #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

    # Additional data to append to log message when logging level for the
    # message is DEBUG. Used by oslo_log.formatters.ContextFormatter
    # (string value)
    #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d

    # Prefix each line of exception output with this format. Used by
    # oslo_log.formatters.ContextFormatter (string value)
    #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

    # Defines the format string for %(user_identity)s that is used in
    # logging_context_format_string. Used by
    # oslo_log.formatters.ContextFormatter (string value)
    #logging_user_identity_format = %(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

    # List of package logging levels in logger=LEVEL pairs. This option is
    # ignored if log_config_append is set. (list value)
    #default_log_levels = amqp=WARN,boto=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,oslo_policy=INFO,dogpile.core.dogpile=INFO

    # Enables or disables publication of error events. (boolean value)
    #publish_errors = false

    # The format for an instance that is passed with the log message.
    # (string value)
    #instance_format = "[instance: %(uuid)s] "

    # The format for an instance UUID that is passed with the log message.
    # (string value)
    #instance_uuid_format = "[instance: %(uuid)s] "

    # Interval, number of seconds, of log rate limiting. (integer value)
    #rate_limit_interval = 0

    # Maximum number of logged messages per rate_limit_interval. (integer
    # value)
    #rate_limit_burst = 0

    # Log level name used by rate limiting. Logs with level greater or
    # equal to rate_limit_except_level are not filtered. An empty string
    # means that all levels are filtered. (string value)
    # Possible values:
    # CRITICAL - <No description provided>
    # ERROR - <No description provided>
    # INFO - <No description provided>
    # WARNING - <No description provided>
    # DEBUG - <No description provided>
    # '' - <No description provided>
    #rate_limit_except_level = CRITICAL

    # Enables or disables fatal status of deprecations. (boolean value)
    #fatal_deprecations = false

    #
    # From oslo.messaging
    #

    # Size of executor thread pool when executor is threading or eventlet.
    # (integer value)
    # Deprecated group/name - [DEFAULT]/rpc_thread_pool_size
    #executor_thread_pool_size = 64

    # Seconds to wait for a response from a call. (integer value)
    #rpc_response_timeout = 60

    # The network address and optional user credentials for connecting to
    # the messaging backend, in URL format. The expected format is:
    #
    # driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
    #
    # Example: rabbit://rabbitmq:password@127.0.0.1:5672//
    #
    # For full details on the fields in the URL see the documentation of
    # oslo_messaging.TransportURL at
    # https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
    # (string value)
    #transport_url = rabbit://

    # The default exchange under which topics are scoped. May be
    # overridden by an exchange name specified in the transport_url
    # option. (string value)
    #control_exchange = openstack

    # Add an endpoint to answer to ping calls. Endpoint is named
    # oslo_rpc_server_ping (boolean value)
    #rpc_ping_enabled = false

    [audit_middleware_notifications]

    #
    # From keystonemiddleware.audit
    #

    # Indicate whether to use oslo_messaging as the notifier. If set to
    # False, the local logger will be used as the notifier. If set to
    # True, the oslo_messaging package must also be present. Otherwise,
    # the local will be used instead. (boolean value)
    #use_oslo_messaging = true

    # The Driver to handle sending notifications. Possible values are
    # messaging, messagingv2, routing, log, test, noop. If not specified,
    # then value from oslo_messaging_notifications conf section is used.
    # (string value)
    #driver = <None>

    # List of AMQP topics used for OpenStack notifications. If not
    # specified, then value from  oslo_messaging_notifications conf
    # section is used. (list value)
    #topics = <None>

    # A URL representing messaging driver to use for notification. If not
    # specified, we fall back to the same configuration used for RPC.
    # (string value)
    #transport_url = <None>

    [cors]

    #
    # From oslo.middleware.cors
    #

    # Indicate whether this resource may be shared with the domain
    # received in the requests "origin" header. Format:
    # "<protocol>://<host>[:<port>]", no trailing slash. Example:
    # https://horizon.example.com (list value)
    #allowed_origin = <None>

    # Indicate that the actual request can include user credentials
    # (boolean value)
    #allow_credentials = true

    # Indicate which headers are safe to expose to the API. Defaults to
    # HTTP Simple Headers. (list value)
    #expose_headers = X-Auth-Token,X-Openstack-Request-Id,X-Project-Id,X-Identity-Status,X-User-Id,X-Storage-Token,X-Domain-Id,X-User-Domain-Id,X-Project-Domain-Id,X-Roles

    # Maximum cache age of CORS preflight requests. (integer value)
    #max_age = 3600

    # Indicate which methods can be used during the actual request. (list
    # value)
    #allow_methods = GET,PUT,POST,DELETE,PATCH

    # Indicate which header field names may be used during the actual
    # request. (list value)
    #allow_headers = X-Auth-Token,X-Openstack-Request-Id,X-Project-Id,X-Identity-Status,X-User-Id,X-Storage-Token,X-Domain-Id,X-User-Domain-Id,X-Project-Domain-Id,X-Roles

    [crypto]

    #
    # From barbican.plugin.crypto
    #

    # Extension namespace to search for plugins. (string value)
    #namespace = barbican.crypto.plugin

    # List of crypto plugins to load. (multi valued)
    #enabled_crypto_plugins = simple_crypto

    [database]

    #
    # From oslo.db
    #

    # If True, SQLite uses synchronous mode. (boolean value)
    #sqlite_synchronous = true

    # The back end to use for the database. (string value)
    #backend = sqlalchemy

    # The SQLAlchemy connection string to use to connect to the database.
    # (string value)
    #connection = <None>

    # The SQLAlchemy connection string to use to connect to the slave
    # database. (string value)
    #slave_connection = <None>

    # The SQLAlchemy asyncio connection string to use to connect to the
    # database. (string value)
    #asyncio_connection = <None>

    # The SQLAlchemy asyncio connection string to use to connect to the
    # slave database. (string value)
    #asyncio_slave_connection = <None>

    # Whether or not to assume a reader context needs to guarantee it can
    # read data committed by a writer assuming replication lag is present;
    # defaults to True. When False, a reader context works the same as
    # async_reader and will select the slave database if present. When
    # using a galera cluster, this can be set to False only if you set
    # mysql_wsrep_sync_wait to 1 (this will guarantee that the reader will
    # wait until writesets are committed).Note that this may incur a
    # performance degradation within the galera cluster. Note also that
    # this parameter has no effect if you do not set any slave_connection.
    # (boolean value)
    #synchronous_reader = true

    # The SQL mode to be used for MySQL sessions. This option, including
    # the default, overrides any server-set SQL mode. To use whatever SQL
    # mode is set by the server configuration, set this to no value.
    # Example: mysql_sql_mode= (string value)
    #mysql_sql_mode = TRADITIONAL

    # For Galera only, configure wsrep_sync_wait causality checks on new
    # connections.  Default is None, meaning don't configure any setting.
    # (integer value)
    #mysql_wsrep_sync_wait = <None>

    # Connections which have been present in the connection pool longer
    # than this number of seconds will be replaced with a new one the next
    # time they are checked out from the pool. (integer value)
    #connection_recycle_time = 3600

    # Maximum number of SQL connections to keep open in a pool. Setting a
    # value of 0 indicates no limit. (integer value)
    #max_pool_size = 5

    # Maximum number of database connection retries during startup. Set to
    # -1 to specify an infinite retry count. (integer value)
    #max_retries = 10

    # Interval between retries of opening a SQL connection. (integer
    # value)
    #retry_interval = 10

    # If set, use this value for max_overflow with SQLAlchemy. (integer
    # value)
    #max_overflow = 50

    # Verbosity of SQL debugging information: 0=None, 100=Everything.
    # (integer value)
    # Minimum value: 0
    # Maximum value: 100
    #connection_debug = 0

    # Add Python stack traces to SQL as comment strings. (boolean value)
    #connection_trace = false

    # If set, use this value for pool_timeout with SQLAlchemy. (integer
    # value)
    #pool_timeout = <None>

    # Enable the experimental use of database reconnect on connection
    # lost. (boolean value)
    #use_db_reconnect = false

    # Seconds between retries of a database transaction. (integer value)
    #db_retry_interval = 1

    # If True, increases the interval between retries of a database
    # operation up to db_max_retry_interval. (boolean value)
    #db_inc_retry_interval = true

    # If db_inc_retry_interval is set, the maximum seconds between retries
    # of a database operation. (integer value)
    #db_max_retry_interval = 10

    # Maximum retries in case of connection error or deadlock error before
    # error is raised. Set to -1 to specify an infinite retry count.
    # (integer value)
    #db_max_retries = 20

    # Optional URL parameters to append onto the connection URL at connect
    # time; specify as param1=value1&param2=value2&... (string value)
    #connection_parameters =

    [dogtag_plugin]

    #
    # From barbican.plugin.dogtag
    #

    # Path to PEM file for authentication (string value)
    #pem_path = /etc/barbican/kra_admin_cert.pem

    # Hostname for the Dogtag instance (string value)
    #dogtag_host = localhost

    # Port for the Dogtag instance (port value)
    # Minimum value: 0
    # Maximum value: 65535
    #dogtag_port = 8443

    # Path to the NSS certificate database (string value)
    #nss_db_path = /etc/barbican/alias

    # Password for the NSS certificate databases (string value)
    #nss_password = <None>

    # User friendly plugin name (string value)
    #plugin_name = Dogtag KRA

    # Retries when storing or generating secrets (integer value)
    #retries = 3

    [healthcheck]

    #
    # From oslo.middleware.healthcheck
    #

    # Show more detailed information as part of the response. Security
    # note: Enabling this option may expose sensitive details about the
    # service being monitored. Be sure to verify that it will not violate
    # your security policies. (boolean value)
    #detailed = false

    # Additional backends that can perform health checks and report that
    # information back as part of a request. (list value)
    #backends =

    # A list of network addresses to limit source ip allowed to access
    # healthcheck information. Any request from ip outside of these
    # network addresses are ignored. (list value)
    #allowed_source_ranges =

    # Ignore requests with proxy headers. (boolean value)
    #ignore_proxied_requests = false

    # Check the presence of a file to determine if an application is
    # running on a port. Used by DisableByFileHealthcheck plugin. (string
    # value)
    #disable_by_file_path = <None>

    # Check the presence of a file based on a port to determine if an
    # application is running on a port. Expects a "port:path" list of
    # strings. Used by DisableByFilesPortsHealthcheck plugin. (list value)
    #disable_by_file_paths =

    # Check the presence of files. Used by EnableByFilesHealthcheck
    # plugin. (list value)
    #enable_by_file_paths =

    [keystone_authtoken]

    #
    # From keystonemiddleware.auth_token
    #

    # Complete "public" Identity API endpoint. This endpoint should not be
    # an "admin" endpoint, as it should be accessible by all end users.
    # Unauthenticated clients are redirected to this endpoint to
    # authenticate. Although this endpoint should ideally be unversioned,
    # client support in the wild varies. (string value)
    #www_authenticate_uri = <None>

    # API version of the Identity API endpoint. (string value)
    #auth_version = <None>

    # Interface to use for the Identity API endpoint. Valid values are
    # "public", "internal" (default) or "admin". (string value)
    #interface = internal

    # Do not handle authorization requests within the middleware, but
    # delegate the authorization decision to downstream WSGI components.
    # (boolean value)
    #delay_auth_decision = false

    # Request timeout value for communicating with Identity API server.
    # (integer value)
    #http_connect_timeout = <None>

    # How many times are we trying to reconnect when communicating with
    # Identity API Server. (integer value)
    #http_request_max_retries = 3

    # Request environment key where the Swift cache object is stored. When
    # auth_token middleware is deployed with a Swift cache, use this
    # option to have the middleware share a caching backend with swift.
    # Otherwise, use the ``memcached_servers`` option instead. (string
    # value)
    #cache = <None>

    # Required if identity server requires client certificate (string
    # value)
    #certfile = <None>

    # Required if identity server requires client certificate (string
    # value)
    #keyfile = <None>

    # A PEM encoded Certificate Authority to use when verifying HTTPs
    # connections. Defaults to system CAs. (string value)
    #cafile = <None>

    # Verify HTTPS connections. (boolean value)
    #insecure = false

    # The region in which the identity server can be found. (string value)
    #region_name = <None>

    # Optionally specify a list of memcached server(s) to use for caching.
    # If left undefined, tokens will instead be cached in-process. (list
    # value)
    # Deprecated group/name - [keystone_authtoken]/memcache_servers
    #memcached_servers = <None>

    # In order to prevent excessive effort spent validating tokens, the
    # middleware caches previously-seen tokens for a configurable duration
    # (in seconds). Set to -1 to disable caching completely. (integer
    # value)
    #token_cache_time = 300

    # (Optional) If defined, indicate whether token data should be
    # authenticated or authenticated and encrypted. If MAC, token data is
    # authenticated (with HMAC) in the cache. If ENCRYPT, token data is
    # encrypted and authenticated in the cache. If the value is not one of
    # these options or empty, auth_token will raise an exception on
    # initialization. (string value)
    # Possible values:
    # None - <No description provided>
    # MAC - <No description provided>
    # ENCRYPT - <No description provided>
    #memcache_security_strategy = None

    # (Optional, mandatory if memcache_security_strategy is defined) This
    # string is used for key derivation. (string value)
    #memcache_secret_key = <None>

    # (Optional) Global toggle for TLS usage when comunicating with the
    # caching servers. (boolean value)
    #memcache_tls_enabled = false

    # (Optional) Path to a file of concatenated CA certificates in PEM
    # format necessary to establish the caching server's authenticity. If
    # tls_enabled is False, this option is ignored. (string value)
    #memcache_tls_cafile = <None>

    # (Optional) Path to a single file in PEM format containing the
    # client's certificate as well as any number of CA certificates needed
    # to establish the certificate's authenticity. This file is only
    # required when client side authentication is necessary. If
    # tls_enabled is False, this option is ignored. (string value)
    #memcache_tls_certfile = <None>

    # (Optional) Path to a single file containing the client's private key
    # in. Otherwhise the private key will be taken from the file specified
    # in tls_certfile. If tls_enabled is False, this option is ignored.
    # (string value)
    #memcache_tls_keyfile = <None>

    # (Optional) Set the available ciphers for sockets created with the
    # TLS context. It should be a string in the OpenSSL cipher list
    # format. If not specified, all OpenSSL enabled ciphers will be
    # available. (string value)
    #memcache_tls_allowed_ciphers = <None>

    # (Optional) Number of seconds memcached server is considered dead
    # before it is tried again. (integer value)
    #memcache_pool_dead_retry = 300

    # (Optional) Maximum total number of open connections to every
    # memcached server. (integer value)
    #memcache_pool_maxsize = 10

    # (Optional) Socket timeout in seconds for communicating with a
    # memcached server. (integer value)
    #memcache_pool_socket_timeout = 3

    # (Optional) Number of seconds a connection to memcached is held
    # unused in the pool before it is closed. (integer value)
    #memcache_pool_unused_timeout = 60

    # (Optional) Number of seconds that an operation will wait to get a
    # memcached client connection from the pool. (integer value)
    #memcache_pool_conn_get_timeout = 10

    # (Optional) Use the advanced (eventlet safe) memcached client pool.
    # (boolean value)
    #memcache_use_advanced_pool = true

    # (Optional) Indicate whether to set the X-Service-Catalog header. If
    # False, middleware will not ask for service catalog on token
    # validation and will not set the X-Service-Catalog header. (boolean
    # value)
    #include_service_catalog = true

    # Used to control the use and type of token binding. Can be set to:
    # "disabled" to not check token binding. "permissive" (default) to
    # validate binding information if the bind type is of a form known to
    # the server and ignore it if not. "strict" like "permissive" but if
    # the bind type is unknown the token will be rejected. "required" any
    # form of token binding is needed to be allowed. Finally the name of a
    # binding method that must be present in tokens. (string value)
    #enforce_token_bind = permissive

    # A choice of roles that must be present in a service token. Service
    # tokens are allowed to request that an expired token can be used and
    # so this check should tightly control that only actual services
    # should be sending this token. Roles here are applied as an ANY check
    # so any role in this list must be present. For backwards
    # compatibility reasons this currently only affects the allow_expired
    # check. (list value)
    #service_token_roles = service

    # When set to True, service tokens must contain a role from the
    # service_token_roles list to be considered valid. This prevents end-
    # user tokens from being used as service tokens and ensures proper
    # service-to-service authentication. Setting this to False is NOT
    # RECOMMENDED as it allows any valid token to be used as a service
    # token, which can bypass access-rule checks and weaken composite-auth
    # protections. (boolean value)
    #service_token_roles_required = true

    # The name or type of the service as it appears in the service
    # catalog. This is used to validate tokens that have restricted access
    # rules. (string value)
    #service_type = <None>

    # Enable the SASL(Simple Authentication and Security Layer) if the
    # SASL_enable is true, else disable. (boolean value)
    #memcache_sasl_enabled = false

    # the user name for the SASL (string value)
    #memcache_username =

    # the username password for SASL (string value)
    #memcache_password =

    # Authentication type to load (string value)
    # Deprecated group/name - [keystone_authtoken]/auth_plugin
    #auth_type = <None>

    # Config Section from which to load plugin specific options (string
    # value)
    #auth_section = <None>

    [keystone_notifications]

    #
    # From barbican.common.config
    #

    # True enables keystone notification listener  functionality. (boolean
    # value)
    #enable = false

    # The default exchange under which topics are scoped. May be
    # overridden by an exchange name specified in the transport_url
    # option. (string value)
    #control_exchange = keystone

    # Keystone notification queue topic name. This name needs to match one
    # of values mentioned in Keystone deployment's 'notification_topics'
    # configuration e.g.    notification_topics=notifications,
    # barbican_notificationsMultiple servers may listen on a topic and
    # messages will be dispatched to one of the servers in a round-robin
    # fashion. That's why Barbican service should have its own dedicated
    # notification queue so that it receives all of Keystone
    # notifications. Alternatively if the chosen oslo.messaging backend
    # supports listener pooling (for example rabbitmq), setting a non-
    # default 'pool_name' option should be preferred. (string value)
    #topic = notifications

    # Pool name for notifications listener. Setting this to a distinctive
    # value will allow barbican notifications listener to receive its own
    # copy of all messages from the topic without without interfering with
    # other services listening on the same topic. This feature is
    # supported only by some oslo.messaging backends (in particilar by
    # rabbitmq) and for those it is preferrable to use it instead of
    # separate notification topic for barbican. (string value)
    #pool_name = <None>

    # True enables requeue feature in case of notification processing
    # error. Enable this only when underlying transport supports this
    # feature. (boolean value)
    #allow_requeue = false

    # Version of tasks invoked via notifications (string value)
    #version = 1.0

    # Define the number of max threads to be used for notification server
    # processing functionality. (integer value)
    #thread_pool_size = 10

    [kmip_plugin]

    #
    # From barbican.plugin.secret_store.kmip
    #

    # Username for authenticating with KMIP server (string value)
    #username = <None>

    # Password for authenticating with KMIP server (string value)
    #password = <None>

    # Address of the KMIP server (string value)
    #host = localhost

    # Port for the KMIP server (port value)
    # Minimum value: 0
    # Maximum value: 65535
    #port = 5696

    # SSL version, maps to the module ssl's constants (string value)
    #ssl_version = PROTOCOL_TLSv1_2

    # File path to concatenated "certification authority" certificates
    # (string value)
    #ca_certs = <None>

    # File path to local client certificate (string value)
    #certfile = <None>

    # File path to local client certificate keyfile (string value)
    #keyfile = <None>

    # Only support PKCS#1 encoding of asymmetric keys (boolean value)
    #pkcs1_only = false

    # User friendly plugin name (string value)
    #plugin_name = KMIP HSM

    [oslo_messaging_kafka]

    #
    # From oslo.messaging
    #

    # Max fetch bytes of Kafka consumer (integer value)
    #kafka_max_fetch_bytes = 1048576

    # Default timeout(s) for Kafka consumers (floating point value)
    #kafka_consumer_timeout = 1.0

    # Group id for Kafka consumer. Consumers in one group will coordinate
    # message consumption (string value)
    #consumer_group = oslo_messaging_consumer

    # Upper bound on the delay for KafkaProducer batching in seconds
    # (floating point value)
    #producer_batch_timeout = 0.0

    # Size of batch for the producer async send (integer value)
    #producer_batch_size = 16384

    # The compression codec for all data generated by the producer. If not
    # set, compression will not be used. Note that the allowed values of
    # this depend on the kafka version (string value)
    # Possible values:
    # none - <No description provided>
    # gzip - <No description provided>
    # snappy - <No description provided>
    # lz4 - <No description provided>
    # zstd - <No description provided>
    #compression_codec = none

    # Enable asynchronous consumer commits (boolean value)
    #enable_auto_commit = false

    # The maximum number of records returned in a poll call (integer
    # value)
    #max_poll_records = 500

    # Protocol used to communicate with brokers (string value)
    # Possible values:
    # PLAINTEXT - <No description provided>
    # SASL_PLAINTEXT - <No description provided>
    # SSL - <No description provided>
    # SASL_SSL - <No description provided>
    #security_protocol = PLAINTEXT

    # Mechanism when security protocol is SASL (string value)
    #sasl_mechanism = PLAIN

    # CA certificate PEM file used to verify the server certificate
    # (string value)
    #ssl_cafile =

    # Client certificate PEM file used for authentication. (string value)
    #ssl_client_cert_file =

    # Client key PEM file used for authentication. (string value)
    #ssl_client_key_file =

    # Client key password file used for authentication. (string value)
    #ssl_client_key_password =

    [oslo_messaging_notifications]

    #
    # From oslo.messaging
    #

    # The Drivers(s) to handle sending notifications. Possible values are
    # messaging, messagingv2, routing, log, test, noop (multi valued)
    #driver =

    # A URL representing the messaging driver to use for notifications. If
    # not set, we fall back to the same configuration used for RPC.
    # (string value)
    #transport_url = <None>

    # AMQP topic used for OpenStack notifications. (list value)
    #topics = notifications

    # The maximum number of attempts to re-send a notification message
    # which failed to be delivered due to a recoverable error. 0 - No
    # retry, -1 - indefinite (integer value)
    #retry = -1

    [oslo_messaging_rabbit]

    #
    # From oslo.messaging
    #

    # Use durable queues in AMQP. If rabbit_quorum_queue is enabled,
    # queues will be durable and this value will be ignored. (boolean
    # value)
    #amqp_durable_queues = false

    # Auto-delete queues in AMQP. (boolean value)
    #amqp_auto_delete = false

    # Size of RPC connection pool. (integer value)
    # Minimum value: 1
    #rpc_conn_pool_size = 30

    # The pool size limit for connections expiration policy (integer
    # value)
    #conn_pool_min_size = 2

    # The time-to-live in sec of idle connections in the pool (integer
    # value)
    #conn_pool_ttl = 1200

    # Connect over SSL. (boolean value)
    #ssl = false

    # SSL version to use (valid only if SSL enabled). Valid values are
    # TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be
    # available on some distributions. (string value)
    #ssl_version =

    # SSL key file (valid only if SSL enabled). (string value)
    #ssl_key_file =

    # SSL cert file (valid only if SSL enabled). (string value)
    #ssl_cert_file =

    # SSL certification authority file (valid only if SSL enabled).
    # (string value)
    #ssl_ca_file =

    # DEPRECATED: When true, verify the broker hostname against the
    # certificate when ``ssl_ca_file`` is set. When false, ``ssl`` with
    # ``ssl_ca_file`` still validates the certificate chain but does not
    # verify the broker hostname. ``ssl=true`` without ``ssl_ca_file``
    # never enables hostname verification. (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Verification is always enabled now
    #ssl_enforce_hostname_verification = true

    # DEPRECATED: Global toggle for enforcing the OpenSSL FIPS mode. This
    # feature requires Python support. This is available in Python 3.9 in
    # all environments and may have been backported to older Python
    # versions on select environments. If the Python executable used does
    # not support OpenSSL FIPS mode, an exception will be raised. (boolean
    # value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: FIPS_mode_set API was removed in OpenSSL 3.0.0. This option
    # has no effect now.
    #ssl_enforce_fips_mode = false

    # How long to wait (in seconds) before reconnecting in response to an
    # AMQP consumer cancel notification. (floating point value)
    # Minimum value: 0.0
    # Maximum value: 4.5
    #kombu_reconnect_delay = 1.0

    # Random time to wait for when reconnecting in response to an AMQP
    # consumer cancel notification. (floating point value)
    # Minimum value: 0.0
    #kombu_reconnect_splay = 0.0

    # EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression
    # will not be used. This option may not be available in future
    # versions. (string value)
    #kombu_compression = <None>

    # How long to wait a missing client before abandoning to send it its
    # replies. This value should not be longer than rpc_response_timeout.
    # (integer value)
    # Deprecated group/name - [oslo_messaging_rabbit]/kombu_reconnect_timeout
    #kombu_missing_consumer_retry_timeout = 60

    # Determines how the next RabbitMQ node is chosen in case the one we
    # are currently connected to becomes unavailable. Takes effect only if
    # more than one RabbitMQ node is provided in config. (string value)
    # Possible values:
    # round-robin - <No description provided>
    # shuffle - <No description provided>
    #kombu_failover_strategy = round-robin

    # The RabbitMQ login method. (string value)
    # Possible values:
    # PLAIN - <No description provided>
    # AMQPLAIN - <No description provided>
    # EXTERNAL - <No description provided>
    # RABBIT-CR-DEMO - <No description provided>
    #rabbit_login_method = AMQPLAIN

    # How frequently to retry connecting with RabbitMQ. (integer value)
    # Minimum value: 1
    #rabbit_retry_interval = 1

    # How long to backoff for between retries when connecting to RabbitMQ.
    # (integer value)
    # Minimum value: 0
    #rabbit_retry_backoff = 2

    # Maximum interval of RabbitMQ connection retries. (integer value)
    # Minimum value: 1
    #rabbit_interval_max = 30

    # Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change
    # this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0,
    # queue mirroring is no longer controlled by the x-ha-policy argument
    # when declaring a queue. If you just want to make sure that all
    # queues (except those with auto-generated names) are mirrored across
    # all nodes, run: "rabbitmqctl set_policy HA '^(?!amq\.).*' '{"ha-
    # mode": "all"}' " (boolean value)
    #rabbit_ha_queues = false

    # Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum
    # queue is a modern queue type for RabbitMQ implementing a durable,
    # replicated FIFO queue based on the Raft consensus algorithm. It is
    # available as of RabbitMQ 3.8.0. If set this option will conflict
    # with the HA queues (``rabbit_ha_queues``) aka mirrored queues, in
    # other words the HA queues should be disabled. Quorum queues are also
    # durable by default so the amqp_durable_queues option is ignored when
    # this option is enabled. (boolean value)
    #rabbit_quorum_queue = false

    # Use quorum queues for transients queues in RabbitMQ. Enabling this
    # option will then make sure those queues are also using quorum kind
    # of rabbit queues, which are HA by default. (boolean value)
    #rabbit_transient_quorum_queue = false

    # Each time a message is redelivered to a consumer, a counter is
    # incremented. Once the redelivery count exceeds the delivery limit
    # the message gets dropped or dead-lettered (if a DLX exchange has
    # been configured) Used only when rabbit_quorum_queue is enabled,
    # Default 0 which means dont set a limit. (integer value)
    #rabbit_quorum_delivery_limit = 0

    # By default all messages are maintained in memory if a quorum queue
    # grows in length it can put memory pressure on a cluster. This option
    # can limit the number of messages in the quorum queue. Used only when
    # rabbit_quorum_queue is enabled, Default 0 which means dont set a
    # limit. (integer value)
    #rabbit_quorum_max_memory_length = 0

    # By default all messages are maintained in memory if a quorum queue
    # grows in length it can put memory pressure on a cluster. This option
    # can limit the number of memory bytes used by the quorum queue. Used
    # only when rabbit_quorum_queue is enabled, Default 0 which means dont
    # set a limit. (integer value)
    #rabbit_quorum_max_memory_bytes = 0

    # Positive integer representing duration in seconds for queue TTL
    # (x-expires). Queues which are unused for the duration of the TTL are
    # automatically deleted. The parameter affects only reply and fanout
    # queues. Setting 0 as value will disable the x-expires. If doing so,
    # make sure you have a rabbitmq policy to delete the queues or you
    # deployment will create an infinite number of queue over time.In case
    # rabbit_stream_fanout is set to True, this option will control data
    # retention policy (x-max-age) for messages in the fanout queue rather
    # then the queue duration itself. So the oldest data in the stream
    # queue will be discarded from it once reaching TTL Setting to 0 will
    # disable x-max-age for stream which make stream grow indefinitely
    # filling up the diskspace (integer value)
    # Minimum value: 0
    #rabbit_transient_queues_ttl = 1800

    # Specifies the number of messages to prefetch. Setting to zero allows
    # unlimited messages. (integer value)
    #rabbit_qos_prefetch_count = 0

    # Number of seconds after which the Rabbit broker is considered down
    # if heartbeat's keep-alive fails (0 disables heartbeat). (integer
    # value)
    #heartbeat_timeout_threshold = 60

    # How often times during the heartbeat_timeout_threshold we check the
    # heartbeat. (integer value)
    #heartbeat_rate = 3

    # DEPRECATED: (DEPRECATED) Enable/Disable the RabbitMQ mandatory flag
    # for direct send. The direct send is used as reply, so the
    # MessageUndeliverable exception is raised in case the client queue
    # does not exist.MessageUndeliverable exception will be used to loop
    # for a timeout to lets a chance to sender to recover.This flag is
    # deprecated and it will not be possible to deactivate this
    # functionality anymore (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: Mandatory flag no longer deactivable.
    #direct_mandatory_flag = true

    # Enable x-cancel-on-ha-failover flag so that rabbitmq server will
    # cancel and notify consumerswhen queue is down (boolean value)
    #enable_cancel_on_failover = false

    # Should we use consistant queue names or random ones (boolean value)
    #use_queue_manager = false

    # Hostname used by queue manager. Defaults to the value returned by
    # socket.gethostname(). (string value)
    #
    # This option has a sample default set, which means that
    # its actual default value may vary from the one documented
    # below.
    #hostname = node1.example.com

    # Process name used by queue manager (string value)
    #
    # This option has a sample default set, which means that
    # its actual default value may vary from the one documented
    # below.
    #processname = nova-api

    # Use stream queues in RabbitMQ (x-queue-type: stream). Streams are a
    # new persistent and replicated data structure ("queue type") in
    # RabbitMQ which models an append-only log with non-destructive
    # consumer semantics. It is available as of RabbitMQ 3.9.0. If set
    # this option will replace all fanout queues with only one stream
    # queue. (boolean value)
    #rabbit_stream_fanout = false

    [oslo_middleware]

    #
    # From oslo.middleware.http_proxy_to_wsgi
    #

    # Whether the application is behind a proxy or not. This determines if
    # the middleware should parse the headers or not. (boolean value)
    #enable_proxy_headers_parsing = false

    [oslo_policy]

    #
    # From oslo.policy
    #

    # This option controls whether or not to use old deprecated defaults
    # when evaluating policies. If ``True``, the old deprecated defaults
    # are not going to be evaluated. This means if any existing token is
    # allowed for old defaults but is disallowed for new defaults, it will
    # be disallowed. If ``False``, the deprecated policy check string is
    # logically OR'd with the new policy check string, allowing for a
    # graceful upgrade experience between releases with new policies,
    # which is the default behavior. (boolean value)
    #enforce_new_defaults = true

    # The relative or absolute path of a file that maps roles to
    # permissions for a given service. Relative paths must be specified in
    # relation to the configuration file setting this option. (string
    # value)
    #policy_file = policy.yaml

    # Default rule. Enforced when a requested rule is not found. (string
    # value)
    #policy_default_rule = default

    # Directories where policy configuration files are stored. They can be
    # relative to any directory in the search path defined by the
    # config_dir option, or absolute paths. The file defined by
    # policy_file must exist for these directories to be searched.
    # Missing or empty directories are ignored. (multi valued)
    #policy_dirs = policy.d

    # Content Type to send and receive data for REST based policy check
    # (string value)
    # Possible values:
    # application/x-www-form-urlencoded - <No description provided>
    # application/json - <No description provided>
    #remote_content_type = application/x-www-form-urlencoded

    # server identity verification for REST based policy check (boolean
    # value)
    #remote_ssl_verify_server_crt = false

    # Absolute path to ca cert file for REST based policy check (string
    # value)
    #remote_ssl_ca_crt_file = <None>

    # Absolute path to client cert for REST based policy check (string
    # value)
    #remote_ssl_client_crt_file = <None>

    # Absolute path client key file REST based policy check (string value)
    #remote_ssl_client_key_file = <None>

    # Timeout in seconds for REST based policy check (floating point
    # value)
    # Minimum value: 0
    #remote_timeout = 60

    [oslo_reports]

    #
    # From oslo.reports
    #

    # Path to a log directory where to create a file (string value)
    #log_dir = <None>

    # The path to a file to watch for changes to trigger the reports,
    # instead of signals. Setting this option disables the signal trigger
    # for the reports. If application is running as a WSGI application it
    # is recommended to use this instead of signals. (string value)
    #file_event_handler = <None>

    # How many seconds to wait between polls when file_event_handler is
    # set (integer value)
    #file_event_handler_interval = 1

    [oslo_versionedobjects]

    #
    # From oslo.versionedobjects
    #

    # Make exception message format errors fatal (boolean value)
    #fatal_exception_format_errors = false

    [p11_crypto_plugin]

    #
    # From barbican.plugin.crypto.p11
    #

    # Path to vendor PKCS11 library (string value)
    #library_path = <None>

    # Token serial number used to identify the token to be used. (string
    # value)
    #token_serial_number = <None>

    # List of labels for one or more tokens to be used. Typically this is
    # a single label, but some HSM devices may require more than one label
    # for Load Balancing or High Availability configurations. (list value)
    #token_labels =

    # Password (PIN) to login to PKCS11 session (string value)
    #login = <None>

    # Master KEK label (as stored in the HSM) (string value)
    #mkek_label = <None>

    # Master KEK length in bytes. (integer value)
    # Minimum value: 1
    #mkek_length = 32

    # Master HMAC Key label (as stored in the HSM) (string value)
    #hmac_label = <None>

    # (Optional) HSM Slot ID that contains the token device to be used.
    # (integer value)
    #slot_id = 1

    # Flag for Read/Write Sessions (boolean value)
    #rw_session = true

    # Project KEK length in bytes. (integer value)
    #pkek_length = 32

    # Project KEK Cache Time To Live, in seconds (integer value)
    #pkek_cache_ttl = 900

    # Project KEK Cache Item Limit (integer value)
    #pkek_cache_limit = 100

    # Secret encryption mechanism (string value)
    #encryption_mechanism = CKM_AES_CBC

    # HMAC Key Type (string value)
    #hmac_key_type = CKK_AES

    # HMAC Key Generation Algorithm used to create the master HMAC Key.
    # (string value)
    #hmac_keygen_mechanism = CKM_AES_KEY_GEN

    # HMAC algorithm used to sign encrypted data. (string value)
    # Deprecated group/name - [p11_crypto_plugin]/hmac_keywrap_mechanism
    #hmac_mechanism = CKM_SHA256_HMAC

    # Key Wrapping algorithm used to wrap Project KEKs. (string value)
    #key_wrap_mechanism = CKM_AES_CBC_PAD

    # Generate IVs for Key Wrapping mechanism. (boolean value)
    #key_wrap_generate_iv = true

    # File to pull entropy for seeding RNG (string value)
    #seed_file =

    # Amount of data to read from file for seed (integer value)
    #seed_length = 32

    # User friendly plugin name (string value)
    #plugin_name = PKCS11 HSM

    # Generate IVs for CKM_AES_GCM mechanism. (boolean value)
    # Deprecated group/name - [p11_crypto_plugin]/generate_iv
    #aes_gcm_generate_iv = true

    # Always set CKA_SENSITIVE=CK_TRUE including CKA_EXTRACTABLE=CK_TRUE
    # keys. (boolean value)
    #always_set_cka_sensitive = true

    # Enable CKF_OS_LOCKING_OK flag when initializing the PKCS#11 client
    # library. (boolean value)
    #os_locking_ok = false

    [queue]

    #
    # From barbican.common.config
    #

    # True enables queuing, False invokes workers synchronously (boolean
    # value)
    #enable = false

    # Queue namespace (string value)
    #namespace = barbican

    # Queue topic name (string value)
    #topic = barbican.workers

    # Version of tasks invoked via queue (string value)
    #version = 1.1

    # Server name for RPC task processing server (string value)
    #server_name = barbican.queue

    # Number of asynchronous worker processes (integer value)
    #asynchronous_workers = 1

    [quotas]

    #
    # From barbican.common.config
    #

    # Number of secrets allowed per project (integer value)
    #quota_secrets = -1

    # Number of orders allowed per project (integer value)
    #quota_orders = -1

    # Number of containers allowed per project (integer value)
    #quota_containers = -1

    # Number of consumers allowed per project (integer value)
    #quota_consumers = -1

    # Number of CAs allowed per project (integer value)
    #quota_cas = -1

    [retry_scheduler]

    #
    # From barbican.common.config
    #

    # Seconds (float) to wait before starting retry scheduler (floating
    # point value)
    #initial_delay_seconds = 10.0

    # Seconds (float) to wait between periodic schedule events (floating
    # point value)
    #periodic_interval_max_seconds = 10.0

    [secretstore]

    #
    # From barbican.plugin.secret_store
    #

    # Extension namespace to search for plugins. (string value)
    #namespace = barbican.secretstore.plugin

    # List of secret store plugins to load. (multi valued)
    #enabled_secretstore_plugins = store_crypto

    # Flag to enable multiple secret store plugin backend support. Default
    # is False (boolean value)
    #enable_multiple_secret_stores = false

    # List of suffix to use for looking up plugins which are supported
    # with multiple backend support. (list value)
    #stores_lookup_suffix = <None>

    [simple_crypto_plugin]

    #
    # From barbican.plugin.crypto.simple
    #

    # Fernet Key-Encryption Key (KEK) to be used by SimpleCrypto Plugin to
    # encrypt Project-specific KEKs. (multi valued)
    #kek =

    # User friendly plugin name (string value)
    #plugin_name = Software Only Crypto

    [vault_plugin]

    #
    # From barbican.plugin.secret_store.vault
    #

    # root token for vault (string value)
    #root_token_id = <None>

    # AppRole role_id for authentication with vault (string value)
    #approle_role_id = <None>

    # AppRole secret_id for authentication with vault (string value)
    #approle_secret_id = <None>

    # Mountpoint of KV store in Vault to use. (string value)
    #kv_mountpoint = secret

    # Path relative to root of KV store in Vault to use. (string value)
    #kv_path = <None>

    # Version of KV store in Vault to use. (integer value)
    # Possible values:
    # 1 - <No description provided>
    # 2 - <No description provided>
    #kv_version = 2

    # Use this endpoint to connect to Vault. (uri value)
    #vault_url = http://127.0.0.1:8200

    # Absolute path to ca cert file (string value)
    #ssl_ca_crt_file = <None>

    # DEPRECATED: SSL Enabled/Disabled (boolean value)
    # This option is deprecated for removal.
    # Its value may be silently ignored in the future.
    # Reason: This option has no effect.
    #use_ssl = false

    # Vault Namespace to use for all requests. Namespaces is a feature
    # available in HasiCorp Vault Enterprise only. (string value)
    #namespace = <None>

this page last updated: 2026-08-18 22:10:53

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug