Skip to content

Commit

Permalink
PKCS#11 doc
Browse files Browse the repository at this point in the history
  • Loading branch information
e-asphyx committed Oct 2, 2024
1 parent 658869d commit 439e48d
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions docs/pkcs11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: pkcs11
title: PKCS#11
---

# PKCS#11 Vault

## Configuration

|||||
|--- |--- |--- |--- |
|Name|Type|Required|Description|
|library_path|string||Library Path|
|pin|string||User PIN|
|slot|string||Slot ID|
|label|string||Limit key search to the specified label (use in case of multiple key pairs in the same token)|
|object_ih|hex||Limit key search to the specified object ID (use in case of multiple key pairs in the same token)|

**Note**: If the token contains multiple key pairs, every pair must have unique label or ID shared between private and public parts.

### Example

```yaml
library_path: /opt/homebrew/lib/softhsm/libsofthsm2.so
pin: 1234
slot: 0x4d0b85a2
label: TestKey
```
## Environment variables
* `PKCS11_PATH`
* `PKCS11_PIN`
* `PKCS11_SLOT`
* `PKCS11_LABEL`
* `PKCS11_OBJECT_ID`

0 comments on commit 439e48d

Please sign in to comment.