| NingSun | 0c89b3c | 2018-02-08 08:34:03 -0800 | [diff] [blame^] | 1 | .TH softhsm2.conf 5 "30 October 2014" "SoftHSM" |
| 2 | .SH NAME |
| 3 | softhsm2.conf \- SoftHSM configuration file |
| 4 | .SH SYNOPSIS |
| 5 | .B softhsm2.conf |
| 6 | .SH DESCRIPTION |
| 7 | This is the configuration file for SoftHSM. It can be found on a |
| 8 | default location, but can also be relocated by using the |
| 9 | environment variable. Any configuration must be done according |
| 10 | to the file format found in this document. |
| 11 | .SH FILE FORMAT |
| 12 | Each configuration option is a pair of name and value separated by |
| 13 | a equality sign. The configuration option must be located on a single line. |
| 14 | .LP |
| 15 | .RS |
| 16 | .nf |
| 17 | <name> = <value> |
| 18 | .fi |
| 19 | .RE |
| 20 | .LP |
| 21 | It is also possible to add comments in the file by using the hash sign. |
| 22 | Anything after the hash sign will be ignored. |
| 23 | .LP |
| 24 | .RS |
| 25 | .nf |
| 26 | # A comment |
| 27 | .RE |
| 28 | .LP |
| 29 | Any empty lines or lines that does not have the correct format will be ignored. |
| 30 | .SH DIRECTORIES.TOKENDIR |
| 31 | The location where SoftHSM can store the tokens. |
| 32 | .LP |
| 33 | .RS |
| 34 | .nf |
| 35 | directories.tokendir = @softhsmtokendir@ |
| 36 | .fi |
| 37 | .RE |
| 38 | .LP |
| 39 | .SH OBJECTSTORE.BACKEND |
| 40 | The backend to use by SoftHSM to store token objects. Either "file" or "db" is supported. |
| 41 | In order to use the "db" backend, the SoftHSM build needs to be configured with "configure --with-objectstore-backend-db" |
| 42 | .LP |
| 43 | .RS |
| 44 | .nf |
| 45 | objectstore.backend = file |
| 46 | .fi |
| 47 | .RE |
| 48 | .LP |
| 49 | .SH LOG.LEVEL |
| 50 | The log level which can be set to ERROR, WARNING, INFO or DEBUG. |
| 51 | .LP |
| 52 | .RS |
| 53 | .nf |
| 54 | log.level = INFO |
| 55 | .fi |
| 56 | .RE |
| 57 | .LP |
| 58 | .SH SLOTS.REMOVABLE |
| 59 | If set to true CKF_REMOVABLE_DEVICE is set in the flags returned by C_GetSlotInfo. Default is false. |
| 60 | .LP |
| 61 | .RS |
| 62 | .nf |
| 63 | slots.removable = true |
| 64 | .fi |
| 65 | .RE |
| 66 | .LP |
| 67 | .SH ENVIRONMENT |
| 68 | .TP |
| 69 | SOFTHSM2_CONF |
| 70 | When defined, the value will be used as path to the configuration file. |
| 71 | .SH FILES |
| 72 | .TP |
| 73 | .I ~/.config/softhsm2/softhsm2.conf |
| 74 | default user-specific location of the SoftHSM configuration file; if it exists it will override the system wide configuration |
| 75 | .TP |
| 76 | .I @default_softhsm2_conf@ |
| 77 | default system-wide location of the SoftHSM configuration file |
| 78 | .TP |
| 79 | .I @default_softhsm2_conf@.sample |
| 80 | an example of a SoftHSM configuration file |
| 81 | .SH AUTHOR |
| 82 | Written by Rickard Bellgrim, Francis Dupont, René Post, and Roland van Rijswijk. |
| 83 | .SH "SEE ALSO" |
| 84 | .IR softhsm2-keyconv (1), |
| 85 | .IR softhsm2-migrate (1), |
| 86 | .IR softhsm2-util (1) |