OpenXPKI::Client::Config

This is a helper package for all cgi based client interfaces to read a client config file base on the name of the script called. It was designed to work inside an apache server but should do in other environments as long as the environment variables are available or adjusted.

Environment variables

OPENXPKI_CLIENT_CONF_DIR

The path of the OpenXPKI base config directory, default /usr/local/etc/openxpki

OPENXPKI_SERVICE_CLIENT_CONF_DIR

SERVICE is the name of the service as given to the constructor. The default value is the basedir plus the name of the service, e.g. /usr/local/etc/openxpki/scep. This is the base directory where the service config is initialized from the file default.conf. If you use the config autodiscovery feature (config name from script name), those files need to be here, too.

Note: Dashes in the servicename are replaced by underscores, e.g. the name for scep-test is OPENXPKI_SCEP_TEST_CLIENT_CONF_DIR.

It is not used if an expicit config file is set with OPENXPKI_SERVICE_CLIENT_CONF_FILE!

OPENXPKI_SERVICE_CLIENT_CONF_FILE

The full path of the config file to use.

OPENXPKI_CLIENT_SERVICE_NAME

The name of the service. Note This overrides the service name passed to the constructor!

Default Configuration

Mostly logger config, used before FCGI is spawned and if no special config is found.

Entity Configuration / Autodiscovery

Most cgi wrappers offer autodiscovery of config files based on the scripts filename, which is espacially handy with rewrite or alias rules. E.g. with the default scep configuration you can use http://servername/scep/my-endpoint in your scep client which will load the entity configuration from the file my-endpoint.conf in the scep config directory (by default /usr/local/etc/openxpki/scep, see also notes above).

If no such file is found, the default configuration is used.

Isntance Variables / Accessor Methods

service

Name of the service as passed during construction, read-only

basepath

The filesystem path holding the config directories, can be set during construction, defaults to /usr/local/etc/openxpki when not read from ENV (see above).

logger

The Log4perl instance. Will be created from the global section of the config file read but can also be set.

default

Accessor to the default configuration, usually read from default.conf.

endpoint

Name of the endpoint that is used for config discovery, set from the script name when "parse_uri" is called. Can also be set explicit.

route

The name of the route extracted from the script name by "parse_uri".

language

The name of the current language, set whenever a config is loaded that has the language propery set. Sets the gettext path when changed.

client

Instance of OpenXPKI::Client, autogenerated with the default socket path if not set.

Methods

parse_uri

Try to parse endpoint and route based on the script url in the environment. Always returns $self, endpoint is set to the empty string if parsing fails.

config

Returns the config hashref for the current endpoint.