softhsm2.conf(5)

1softhsm2.conf(5)              File Formats Manual             softhsm2.conf(5)
2
3
4

NAME

6       softhsm2.conf - SoftHSM configuration file
7

SYNOPSIS

9       softhsm2.conf
10

DESCRIPTION

12       This  is  the  configuration  file  for  SoftHSM.  It can be found on a
13       default location, but can also be relocated by  using  the  environment
14       variable.  Any  configuration must be done according to the file format
15       found in this document.
16

FILE FORMAT

18       Each configuration option is a pair of name and value  separated  by  a
19       equality  sign.  The  configuration  option must be located on a single
20       line.
21
22              <name> = <value>
23
24       It is also possible to add comments in the file by using the hash sign.
25       Anything after the hash sign will be ignored.
26
27              # A comment
28
29       Any empty lines or lines that does not have the correct format will be ignored.
30

DIRECTORIES.TOKENDIR

32       The location where SoftHSM can store the tokens.
33
34              directories.tokendir = /var/lib/softhsm/tokens/
35

OBJECTSTORE.BACKEND

37       The  backend to use by SoftHSM to store token objects. Either "file" or
38       "db" is supported.  In order to use the "db" backend, the SoftHSM build
39       needs to be configured with "configure --with-objectstore-backend-db"
40
41              objectstore.backend = file
42

LOG.LEVEL

44       The log level which can be set to ERROR, WARNING, INFO or DEBUG.
45
46              log.level = INFO
47

SLOTS.REMOVABLE

49       If  set  to  true  CKF_REMOVABLE_DEVICE is set in the flags returned by
50       C_GetSlotInfo. Default is false.
51
52              slots.removable = true
53

TOKEN.MECHANISMS

55       Allows to enable and disable any of the PKCS#11 mechanisms reported  in
56       the  C_GetMechanismList().  The option accepts string argument contain‐
57       ing the comma separated list of all algorithms that should  be  enabled
58       (do  not forget about the keygen mechanisms).  The list can be prefixed
59       with minus sign "-" to list only the  disabled  mechanisms.   Addition‐
60       ally,  special  keyword  ALL can be used to enable all the known mecha‐
61       nisms (default). Unknown  mechanisms  are  ignored.   This  option  has
62       higher  priority  than  the CKA_ALLOWED_MECHANISMS attribute on the key
63       objects.
64
65              slots.mechanisms = ALL
66

LIBRARY.RESET_ON_FORK

68       If set to true, the library will reset the state on fork.   Default  is
69       false.
70
71              library.reset_on_fork = true
72

ENVIRONMENT

74       SOFTHSM2_CONF
75              When  defined,  the value will be used as path to the configura‐
76              tion file.
77

FILES

79       ~/.config/softhsm2/softhsm2.conf
80              default user-specific  location  of  the  SoftHSM  configuration
81              file;  if  it exists it will override the system wide configura‐
82              tion
83
84       /etc/softhsm2.conf
85              default system-wide location of the SoftHSM configuration file
86
87       /etc/softhsm2.conf.sample
88              an example of a SoftHSM configuration file
89

AUTHOR

91       Written by Rickard Bellgrim, Francis Dupont, René Post, and Roland  van
92       Rijswijk.
93