@atproto/jwk
Version:
A library for working with JSON Web Keys (JWKs) in TypeScript. This is meant to be extended by environment-specific libraries like @atproto/jwk-jose.
467 lines • 16.3 kB
TypeScript
import { z } from 'zod';
/**
* JSON Web Key Set schema. The keys set, in this context, represents a
* collection of JSON Web Keys (JWKs), that can be both public and private.
*/
export declare const jwksSchema: z.ZodObject<{
keys: z.ZodEffects<z.ZodArray<z.ZodUnknown, "many">, ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "RSA";
alg?: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | undefined;
n: string;
e: string;
d?: string | undefined;
p?: string | undefined;
q?: string | undefined;
dp?: string | undefined;
dq?: string | undefined;
qi?: string | undefined;
oth?: {
r?: string | undefined;
d?: string | undefined;
t?: string | undefined;
}[] | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256" | "ES384" | "ES512" | undefined;
crv: "P-256" | "P-384" | "P-521";
x: string;
y: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256K" | undefined;
crv: "secp256k1";
x: string;
y: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "OKP";
alg?: "EdDSA" | undefined;
crv: "Ed25519" | "Ed448";
x: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "oct";
alg?: "HS256" | "HS384" | "HS512" | undefined;
k: string;
})[], unknown[]>;
}, "strip", z.ZodTypeAny, {
keys: ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "RSA";
alg?: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | undefined;
n: string;
e: string;
d?: string | undefined;
p?: string | undefined;
q?: string | undefined;
dp?: string | undefined;
dq?: string | undefined;
qi?: string | undefined;
oth?: {
r?: string | undefined;
d?: string | undefined;
t?: string | undefined;
}[] | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256" | "ES384" | "ES512" | undefined;
crv: "P-256" | "P-384" | "P-521";
x: string;
y: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256K" | undefined;
crv: "secp256k1";
x: string;
y: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "OKP";
alg?: "EdDSA" | undefined;
crv: "Ed25519" | "Ed448";
x: string;
d?: string | undefined;
} | {
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "oct";
alg?: "HS256" | "HS384" | "HS512" | undefined;
k: string;
})[];
}, {
keys: unknown[];
}>;
export type Jwks = z.output<typeof jwksSchema>;
/**
* Public JSON Web Key Set schema.
*/
export declare const jwksPubSchema: z.ZodObject<{
keys: z.ZodEffects<z.ZodArray<z.ZodUnknown, "many">, ((({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "RSA";
alg?: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | undefined;
n: string;
e: string;
d?: string | undefined;
p?: string | undefined;
q?: string | undefined;
dp?: string | undefined;
dq?: string | undefined;
qi?: string | undefined;
oth?: {
r?: string | undefined;
d?: string | undefined;
t?: string | undefined;
}[] | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256" | "ES384" | "ES512" | undefined;
crv: "P-256" | "P-384" | "P-521";
x: string;
y: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256K" | undefined;
crv: "secp256k1";
x: string;
y: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "OKP";
alg?: "EdDSA" | undefined;
crv: "Ed25519" | "Ed448";
x: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
})) & {
d?: never;
})[], unknown[]>;
}, "strip", z.ZodTypeAny, {
keys: ((({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "RSA";
alg?: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | undefined;
n: string;
e: string;
d?: string | undefined;
p?: string | undefined;
q?: string | undefined;
dp?: string | undefined;
dq?: string | undefined;
qi?: string | undefined;
oth?: {
r?: string | undefined;
d?: string | undefined;
t?: string | undefined;
}[] | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256" | "ES384" | "ES512" | undefined;
crv: "P-256" | "P-384" | "P-521";
x: string;
y: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "EC";
alg?: "ES256K" | undefined;
crv: "secp256k1";
x: string;
y: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
}) | ({
kid?: string | undefined;
use?: "enc" | "sig" | undefined;
key_ops?: ("decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey")[] | undefined;
x5c?: string[] | undefined;
x5t?: string | undefined;
'x5t#S256'?: string | undefined;
x5u?: string | undefined;
ext?: boolean | undefined;
iat?: number | undefined;
exp?: number | undefined;
nbf?: number | undefined;
revoked?: {
revoked_at: number;
reason?: string | undefined;
} | undefined;
kty: "OKP";
alg?: "EdDSA" | undefined;
crv: "Ed25519" | "Ed448";
x: string;
d?: string | undefined;
} & {
kid: NonNullable<unknown>;
})) & {
d?: never;
})[];
}, {
keys: unknown[];
}>;
export type JwksPub = z.output<typeof jwksPubSchema>;
//# sourceMappingURL=jwks.d.ts.map