Skip to content

Commit

Permalink
PIVSession documentation structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
jensutbult committed Feb 21, 2024
1 parent 44f162a commit 492e7d6
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 0 deletions.
61 changes: 61 additions & 0 deletions YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# ``YubiKit/PIVSession``

@Metadata {
@DocumentationExtension(mergeBehavior: append)
}

## Topics

### Managing the PIVSession

- ``session(withConnection:)``
- ``end()``
- ``reset()``

### Running commands in the PIV application

- ``supports(_:)``
- ``signWithKeyInSlot(_:keyType:algorithm:message:)``
- ``decryptWithKeyInSlot(slot:algorithm:encrypted:)``
- ``calculateSecretKeyInSlot(slot:peerPublicKey:)``
- ``attestKeyInSlot(slot:)``
- ``generateKeyInSlot(slot:type:pinPolicy:touchPolicy:)``
- ``putKey(key:inSlot:pinPolicy:touchPolicy:)``
- ``putCertificate(certificate:inSlot:compress:)``
- ``getCertificateInSlot(_:)``
- ``deleteCertificateInSlot(slot:)``
- ``setManagementKey(_:type:requiresTouch:)``
- ``authenticateWith(managementKey:keyType:)``
- ``getSlotMetadata(_:)``
- ``getManagementKeyMetadata()``
- ``reset()``
- ``getSerialNumber()``
- ``verifyPin(_:)``
- ``setPin(_:oldPin:)``
- ``setPuk(_:oldPuk:)``
- ``unblockPinWithPuk(_:newPin:)``
- ``getPinMetadata()``
- ``getPukMetadata()``
- ``getPinAttempts()``
- ``set(pinAttempts:pukAttempts:)``
- ``blockPin(counter:)``
- ``blockPuk(counter:)``



### Return types

- ``PIVTouchPolicy``
- ``PIVPinPolicy``
- ``PIVSlot``
- ``PIVKeyType``
- ``PIVVerifyPinResult``
- ``PIVManagementKeyMetadata``
- ``PIVSlotMetadata``
- ``PIVPinPukMetadata``
- ``PIVManagementKeyType``

### Errors

- ``PIVSessionError``

5 changes: 5 additions & 0 deletions YubiKit/YubiKit/YubiKit.docc/Resources/SessionExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@

- ``end()``

### Session feature support

- ``SessionFeature``
- ``supports(_:)``

### Errors

- ``SessionError``
1 change: 1 addition & 0 deletions YubiKit/YubiKit/YubiKit.docc/Resources/YubiKit.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,4 @@ communication with the YubiKey.
- ``Session``
- ``OATHSession``
- ``ManagementSession``
- ``PIVSession``

0 comments on commit 492e7d6

Please sign in to comment.