oauth/sh.christian.ozone.oauth/DpopKeyPair

DpopKeyPair

@Serializable(with = DerDpopKeyPairSerializer::class)

Represents a DPoP (Demonstrating Proof of Possession) key pair, which consists of a public and private key pair.

This key pair is used to sign DPoP headers for OAuth requests, ensuring that the request is made by the holder of the private key (ie: this application instance). DPoP keys are also used to authorize requests made to an atproto server like Bluesky.

Keys can be imported or exported in various formats depending on the target platform currently being used:

JS: Does not support publicKeyBlocking or privateKeyBlocking methods but supports all key formats.
JVM: Does not support JWK for importing or exporting keys.
Android: Does not support JWK for importing or exporting keys.
iOS: Does not support JWK for importing or exporting keys, and does not support RAW for importing keys.

Types

Companion

object Companion

PrivateKeyFormat

enum PrivateKeyFormat : Enum<DpopKeyPair.PrivateKeyFormat>

PublicKeyFormat

enum PublicKeyFormat : Enum<DpopKeyPair.PublicKeyFormat>

Functions

privateKey

suspend fun privateKey(format: DpopKeyPair.PrivateKeyFormat): ByteArray

Export the private key of the DPoP keypair to a byte array using the specified format.

privateKeyBlocking

fun privateKeyBlocking(format: DpopKeyPair.PrivateKeyFormat): ByteArray

Export the private key of the DPoP keypair to a byte array using the specified format.

publicKey

suspend fun publicKey(format: DpopKeyPair.PublicKeyFormat): ByteArray

Export the public key of the DPoP keypair to a byte array using the specified format.

publicKeyBlocking

fun publicKeyBlocking(format: DpopKeyPair.PublicKeyFormat): ByteArray

Export the public key of the DPoP keypair to a byte array using the specified format.