-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44f162a
commit 492e7d6
Showing
3 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
61 changes: 61 additions & 0 deletions
61
YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,11 @@ | |
|
||
- ``end()`` | ||
|
||
### Session feature support | ||
|
||
- ``SessionFeature`` | ||
- ``supports(_:)`` | ||
|
||
### Errors | ||
|
||
- ``SessionError`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -67,3 +67,4 @@ communication with the YubiKey. | |
- ``Session`` | ||
- ``OATHSession`` | ||
- ``ManagementSession`` | ||
- ``PIVSession`` |