softhsm.conf.5.in

.TH softhsm.conf 5 "29 August 2012" "SoftHSM"
.SH NAME
softhsm.conf \- SoftHSM configuration file
.SH SYNOPSIS
.B softhsm.conf
.SH DESCRIPTION
In PKCS#11 you need tokens in order to do cryptographic operations.
Tokens can be viewed as object stores where you can store e.g. private
and public keys.
A token must then be attached to a slot so that you
can use it.
.PP
Slots and tokens are handled by the SoftHSM configuration file.
The given paths in the configuration file are just an indication to 
SoftHSM on where it should store the information for each token.
The token
databases will be created when the tokens gets initialized.
.SH FILE FORMAT
Each pair of slot and token are configured on one line.
Starting with an unsigned
integer as the slot ID and then a path where
SoftHSM can create a SQLite database.
These parameters are separated by a semicolon.
It is OK to have extra space between
the parameters, since these will be ignored.
.LP
.RS
.nf
.IR <Slot_ID> : <Path_to_the_token_database>
.fi
.RE
.LP
It is also possible to add comments in the file by using the hash sign.
Anything
after the hash sign will be ignored.
.LP
.RS
.nf
.I #<text>
.RE
.LP
Any line that does not have the correct format will be ignored.
.SH EXAMPLE
.LP
.RS
.nf
0:@softhsmdbdir@/slot0.db

1:/home/user/token.database                # My own token
.fi
.RE
.LP
.SH ENVIRONMENT
.TP
SOFTHSM_CONF
When defined, the value
will be used
as path to the configuration file.
.SH FILES
.TP
.I @default_softhsm_conf@
default location of the SoftHSM configuration file
.TP
.I @default_softhsm_conf@.sample
an example of a SoftHSM configuration file
.SH AUTHOR
Written by Rickard Bellgrim.
.SH "SEE ALSO"
.IR softhsm (1),
.IR softhsm-keyconv (1).