Windows PowerShell command on Get-command config

Manual Pages for UNIX Operating System command usage for man config

OpenSSL config(5openssl)

NNNNAAAAMMMMEEEE

config - OpenSSL CONF library configuration files

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN

The OpenSSL CONF library can be used to read configuration

files. It is used for the OpenSSL master configuration file

ooooppppeeeennnnssssssssllll....ccccnnnnffff and in a few other places like SSSSPPPPKKKKAAAACCCC files and certificate extension files for the xxxx555500009999 utility. OpenSSL applications can also use the CONF library for their own purposes.

A configuration file is divided into a number of sections.

Each section starts with a line [[[[ sssseeeeccccttttiiiioooonnnn_nnnnaaaammmmeeee ]]]] and ends

when a new section is started or end of file is reached. A section name can consist of alphanumeric characters and underscores.

The first section of a configuration file is special and is

referred to as the ddddeeeeffffaaaauuuulllltttt section this is usually unnamed and is from the start of file until the first named section. When a name is being looked up it is first looked up in a named section (if any) and then the default section. The environment is mapped onto a section called EEEENNNNVVVV.

Comments can be included by preceding them with the ####

character

Each section in a configuration file consists of a number of

name and value pairs of the form nnnnaaaammmmeeee====vvvvaaaalllluuuueeee The nnnnaaaammmmeeee string can contain any alphanumeric characters as

well as a few punctuation symbols such as .... ,,,, ;;;; and _.

The vvvvaaaalllluuuueeee string consists of the string following the ==== character until end of line with any leading and trailing white space removed. The value string undergoes variable expansion. This can be

done by including the form $$$$vvvvaaaarrrr or $$$${{{{vvvvaaaarrrr}}}}: this will

substitute the value of the named variable in the current section. It is also possible to substitute a value from

another section using the syntax $$$$sssseeeeccccttttiiiioooonnnn::::::::nnnnaaaammmmeeee or

$$$${{{{sssseeeeccccttttiiiioooonnnn::::::::nnnnaaaammmmeeee}}}}. By using the form $$$$EEEENNNNVVVV::::::::nnnnaaaammmmeeee environment

variables can be substituted. It is also possible to assign values to environment variables by using the name EEEENNNNVVVV::::::::nnnnaaaammmmeeee, this will work if the program looks up environment variables using the CCCCOOOONNNNFFFF library instead of calling ggggeeeetttteeeennnnvvvv(((()))) directly. It is possible to escape certain characters by using any kind of quote or the \\\\ character. By making the last character of a line a \\\\ a vvvvaaaalllluuuueeee string can be spread across

25/Nov/2004 Last change: 0.9.8o 1

OpenSSL config(5openssl)

multiple lines. In addition the sequences \\\\nnnn, \\\\rrrr, \\\\bbbb and \\\\tttt are recognized. OOOOPPPPEEEENNNNSSSSSSSSLLLL LLLLIIIIBBBBRRRRAAAARRRRYYYY CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN In OpenSSL 0.9.7 and later applications can automatically

configure certain aspects of OpenSSL using the master

OpenSSL configuration file, or optionally an alternative

configuration file. The ooooppppeeeennnnssssssssllll utility includes this

functionality: any sub command uses the master OpenSSL

configuration file unless an option is used in the sub

command to use an alternative configuration file.

To enable library configuration the default section needs to

contain an appropriate line which points to the main

configuration section. The default name is ooooppppeeeennnnssssssssllll_ccccoooonnnnffff

which is used by the ooooppppeeeennnnssssssssllll utility. Other applications may

use an alternative name such as mmmmyyyyaaaapppppppplllliiiiccccaaaattttoooonnnn_ccccoooonnnnffff.

The configuration section should consist of a set of name

value pairs which contain specific module configuration

information. The nnnnaaaammmmeeee represents the name of the

configuration module the meaning of the vvvvaaaalllluuuueeee is module

specific: it may, for example, represent a further

configuration section containing configuration module

specific information. E.g.

openssl_conf = openssl_init

[openssl_init]

oid_section = new_oids

engines = engine_section

[new_oids]

... new oids here ...

[engine_section]

... engine stuff here ...

Currently there are two configuration modules. One for ASN1

objects another for ENGINE configuration.

AAAASSSSNNNN1111 OOOOBBBBJJJJEEEECCCCTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN MMMMOOOODDDDUUUULLLLEEEE

This module has the name ooooiiiidddd_sssseeeeccccttttiiiioooonnnn. The value of this

variable points to a section containing name value pairs of OIDs: the name is the OID short and long name, the value is the numerical form of the OID. Although some of the ooooppppeeeennnnssssssssllll utility sub commands already have their own ASN1 OBJECT section functionality not all do. By using the ASN1 OBJECT

25/Nov/2004 Last change: 0.9.8o 2

OpenSSL config(5openssl)

configuration module aaaallllllll the ooooppppeeeennnnssssssssllll utility sub commands

can see the new objects as well as any compliant applications. For example:

[new_oids]

some_new_oid = 1.2.3.4

some_other_oid = 1.2.3.5

In OpenSSL 0.9.8 it is also possible to set the value to the long name followed by a comma and the numerical OID form. For example: shortName = some object long name, 1.2.3.4 EEEENNNNGGGGIIIINNNNEEEE CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN MMMMOOOODDDDUUUULLLLEEEE

This ENGINE configuration module has the name eeeennnnggggiiiinnnneeeessss. The

value of this variable points to a section containing

further ENGINE configuration information.

The section pointed to by eeeennnnggggiiiinnnneeeessss is a table of engine names

(though see eeeennnnggggiiiinnnneeee_iiiidddd below) and further sections containing

configuration informations specific to each ENGINE.

Each ENGINE specific section is used to set default algorithms, load dynamic, perform initialization and send ctrls. The actual operation performed depends on the command name which is the name of the name value pair. The currently supported commands are listed below. For example:

[engine_section]

# Configure ENGINE named "foo"

foo = foo_section

# Configure ENGINE named "bar"

bar = bar_section

[foo_section]

... foo ENGINE specific commands ...

[bar_section]

... "bar" ENGINE specific commands ...

The command eeeennnnggggiiiinnnneeee_iiiidddd is used to give the ENGINE name. If

used this command must be first. For example:

25/Nov/2004 Last change: 0.9.8o 3

OpenSSL config(5openssl)

[engine_section]

# This would normally handle an ENGINE named "foo"

foo = foo_section

[foo_section]

# Override default name and use "myfoo" instead.

engine_id = myfoo

The command ddddyyyynnnnaaaammmmiiiicccc_ppppaaaatttthhhh loads and adds an ENGINE from the

given path. It is equivalent to sending the ctrls SSSSOOOO_PPPPAAAATTTTHHHH

with the path argument followed by LLLLIIIISSSSTTTT_AAAADDDDDDDD with value 2 and

LLLLOOOOAAAADDDD to the dynamic ENGINE. If this is not the required behaviour then alternative ctrls can be sent directly to the dynamic ENGINE using ctrl commands. The command iiiinnnniiiitttt determines whether to initialize the ENGINE. If the value is 0000 the ENGINE will not be initialized, if 1111 and attempt it made to initialized the ENGINE immediately. If the iiiinnnniiiitttt command is not present then an attempt will be made to initialize the ENGINE after all commands in its section have been processed.

The command ddddeeeeffffaaaauuuulllltttt_aaaallllggggoooorrrriiiitttthhhhmmmmssss sets the default algorithms

an ENGINE will supply using the functions

EEEENNNNGGGGIIIINNNNEEEE_sssseeeetttt_ddddeeeeffffaaaauuuulllltttt_ssssttttrrrriiiinnnngggg(((())))

If the name matches none of the above command names it is assumed to be a ctrl command which is sent to the ENGINE. The value of the command is the argument to the ctrl command. If the value is the string EEEEMMMMPPPPTTTTYYYY then no value is sent to the command. For example:

[engine_section]

# Configure ENGINE named "foo"

foo = foo_section

[foo_section]

# Load engine from DSO

dynamic_path = /some/path/fooengine.so

# A foo specific ctrl.

some_ctrl = some_value

# Another ctrl that doesn't take a value.

other_ctrl = EMPTY

# Supply all default algorithms

default_algorithms = ALL

NNNNOOOOTTTTEEEESSSS

If a configuration file attempts to expand a variable that

25/Nov/2004 Last change: 0.9.8o 4

OpenSSL config(5openssl)

doesn't exist then an error is flagged and the file will not load. This can happen if an attempt is made to expand an environment variable that doesn't exist. For example in a previous version of OpenSSL the default OpenSSL master

configuration file used the value of HHHHOOOOMMMMEEEE which may not be

defined on non Unix systems and would cause an error. This can be worked around by including a ddddeeeeffffaaaauuuulllltttt section to provide a default value: then if the environment lookup fails the default value will be used instead. For this to work properly the default value must be defined earlier in

the configuration file than the expansion. See the EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS

section for an example of how to do this. If the same variable exists in the same section then all but the last value will be silently ignored. In certain circumstances such as with DNs the same field may occur multiple times. This is usually worked around by ignoring any characters before an initial .... e.g. 1.OU="My first OU" 2.OU="My Second OU" EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS

Here is a sample configuration file using some of the

features mentioned above.

# This is the default section.

HOME=/temp

RANDFILE= ${ENV::HOME}/.rnd

configdir=$ENV::HOME/config

[ section_one ]

# We are now in section one.

# Quotes permit leading and trailing whitespace

any = " any variable name " other = A string that can \ cover several lines \ by including \\ characters message = Hello World\n

[ section_two ]

greeting = $section_one::message

This next example shows how to expand environment variables

25/Nov/2004 Last change: 0.9.8o 5

OpenSSL config(5openssl)

safely. Suppose you want a variable called ttttmmmmppppffffiiiilllleeee to refer to a temporary filename. The directory it is placed in can determined by the the TTTTEEEEMMMMPPPP or TTTTMMMMPPPP environment variables but they may not be set to any value at all. If you just include the environment variable names and the variable doesn't exist then this will cause an error when an attempt is made

to load the configuration file. By making use of the default

section both values can be looked up with TTTTEEEEMMMMPPPP taking priority and ////ttttmmmmpppp used if neither is defined: TMP=/tmp

# The above value is used if TMP isn't in the environment

TEMP=$ENV::TMP

# The above value is used if TEMP isn't in the environment

tmpfile=${ENV::TEMP}/tmp.filename

BBBBUUUUGGGGSSSS Currently there is no way to include characters using the octal \\\\nnnnnnnnnnnn form. Strings are all null terminated so nulls cannot form part of the value. The escaping isn't quite right: if you want to use sequences like \\\\nnnn you can't use any quote escaping on the same line. Files are loaded in a single pass. This means that an variable expansion will only work if the variables referenced are defined earlier in the file. SSSSEEEEEEEE AAAALLLLSSSSOOOO x509(1), req(1), ca(1)

25/Nov/2004 Last change: 0.9.8o 6