Index

Modules: webtokens, webtokens/api, webtokens/jwk, webtokens/jws, webtokens/libjwt.

API symbols

`$`:

• api: proc `$`(alg: Alg): string

`[]=`:

• api: proc `[]=`(b: JwtBuilder; name: string; value: bool)
• api: proc `[]=`(b: JwtBuilder; name: string; value: int64)
• api: proc `[]=`(b: JwtBuilder; name: string; value: JsonNode)
• api: proc `[]=`(b: JwtBuilder; name: string; value: string)

Alg:

• api: type Alg

aud:

• api: proc aud(c: JwtChecker): string

b64urlDecode:

• api: proc b64urlDecode(s: string): string

ClaimKind:

• api: type ClaimKind

claimTime:

• api: proc claimTime(c: JwtChecker; kind: ClaimKind): Time

count:

• api: proc count(set: JwkSet): int

CryptoProvider:

• api: type CryptoProvider

currentCryptoProvider:

• api: proc currentCryptoProvider(): CryptoProvider

currentCryptoProviderName:

• api: proc currentCryptoProviderName(): string

enableIat:

• api: proc enableIat(b: JwtBuilder; enable = true)

findByKid:

• api: proc findByKid(set: JwkSet; kid: string): JwkItem

fromPayload:

• api: proc fromPayload(c: JwtChecker; key: string): JsonNode

generate:

• api: proc generate(b: JwtBuilder): string

generateJwkSet:

• jwk: proc generateJwkSet(count = 1; keyLen = 32): JsonNode

generateOctJwk:

• jwk: proc generateOctJwk(kid = "hmac-key"; alg = "HS256"; keyLen = 32): JsonNode

getClaim:

• api: proc getClaim(c: JwtChecker; kind: ClaimKind): string

isPrivate:

• api: proc isPrivate(it: JwkItem): bool

iss:

• api: proc iss(c: JwtChecker): string

itemAlg:

• api: proc itemAlg(it: JwkItem): Alg

itemByIndex:

• api: proc itemByIndex(set: JwkSet; idx: int): JwkItem

itemCurve:

• api: proc itemCurve(it: JwkItem): string

itemKeyType:

• api: proc itemKeyType(it: JwkItem): jwk_key_type_t

itemKid:

• api: proc itemKid(it: JwkItem): string

itemOctKey:

• api: proc itemOctKey(it: JwkItem): seq[byte]

itemPem:

• api: proc itemPem(it: JwkItem): string

itemUse:

• api: proc itemUse(it: JwkItem): jwk_pub_key_use_t

jti:

• api: proc jti(c: JwtChecker): string

JwkError:

• api: object JwkError

JwkItem:

• api: type JwkItem

jwk_item_t:

• libjwt: object jwk_item_t

jwk_key_op_t:

• libjwt: enum jwk_key_op_t

jwk_key_type_t:

• libjwt: enum jwk_key_type_t

jwk_pub_key_use_t:

• libjwt: enum jwk_pub_key_use_t

jwks_create:

• libjwt: proc jwks_create(jwk_json_str: cstring): ptr jwk_set_t

jwks_create_fromfile:

• libjwt: proc jwks_create_fromfile(file_name: cstring): ptr jwk_set_t

jwks_create_fromfp:

• libjwt: proc jwks_create_fromfp(input: pointer): ptr jwk_set_t

jwks_create_fromurl:

• libjwt: proc jwks_create_fromurl(url: cstring; verify: cint): ptr jwk_set_t

jwks_create_strn:

• libjwt: proc jwks_create_strn(jwk_json_str: cstring; len: csize_t): ptr jwk_set_t

jwks_error:

• libjwt: proc jwks_error(jwk_set: ptr jwk_set_t): cint

jwks_error_any:

• libjwt: proc jwks_error_any(jwk_set: ptr jwk_set_t): cint

jwks_error_clear:

• libjwt: proc jwks_error_clear(jwk_set: ptr jwk_set_t)

jwks_error_msg:

• libjwt: proc jwks_error_msg(jwk_set: ptr jwk_set_t): cstring

JwkSet:

• api: type JwkSet

jwk_set_t:

• libjwt: object jwk_set_t

jwks_find_bykid:

• libjwt: proc jwks_find_bykid(jwk_set: ptr jwk_set_t; kid: cstring): ptr jwk_item_t

jwks_free:

• libjwt: proc jwks_free(jwk_set: ptr jwk_set_t)

jwks_item_alg:

• libjwt: proc jwks_item_alg(item: ptr jwk_item_t): jwt_alg_t

jwks_item_count:

• libjwt: proc jwks_item_count(jwk_set: ptr jwk_set_t): csize_t

jwks_item_curve:

• libjwt: proc jwks_item_curve(item: ptr jwk_item_t): cstring

jwks_item_error:

• libjwt: proc jwks_item_error(item: ptr jwk_item_t): cint

jwks_item_error_msg:

• libjwt: proc jwks_item_error_msg(item: ptr jwk_item_t): cstring

jwks_item_free:

• libjwt: proc jwks_item_free(jwk_set: ptr jwk_set_t; index: csize_t): cint

jwks_item_free_all:

• libjwt: proc jwks_item_free_all(jwk_set: ptr jwk_set_t): cint

jwks_item_free_bad:

• libjwt: proc jwks_item_free_bad(jwk_set: ptr jwk_set_t): cint

jwks_item_get:

• libjwt: proc jwks_item_get(jwk_set: ptr jwk_set_t; index: csize_t): ptr jwk_item_t

jwks_item_is_private:

• libjwt: proc jwks_item_is_private(item: ptr jwk_item_t): cint

jwks_item_key_bits:

• libjwt: proc jwks_item_key_bits(item: ptr jwk_item_t): cint

jwks_item_key_oct:

• libjwt: proc jwks_item_key_oct(item: ptr jwk_item_t; buf: ptr ptr uint8; len: ptr csize_t): cint

jwks_item_key_ops:

• libjwt: proc jwks_item_key_ops(item: ptr jwk_item_t): jwk_key_op_t

jwks_item_kid:

• libjwt: proc jwks_item_kid(item: ptr jwk_item_t): cstring

jwks_item_kty:

• libjwt: proc jwks_item_kty(item: ptr jwk_item_t): jwk_key_type_t

jwks_item_pem:

• libjwt: proc jwks_item_pem(item: ptr jwk_item_t): cstring

jwks_item_use:

• libjwt: proc jwks_item_use(item: ptr jwk_item_t): jwk_pub_key_use_t

jwks_load:

• libjwt: proc jwks_load(jwk_set: ptr jwk_set_t; jwk_json_str: cstring): ptr jwk_set_t

jwks_load_fromfile:

• libjwt: proc jwks_load_fromfile(jwk_set: ptr jwk_set_t; file_name: cstring): ptr jwk_set_t

jwks_load_fromfp:

• libjwt: proc jwks_load_fromfp(jwk_set: ptr jwk_set_t; input: pointer): ptr jwk_set_t

jwks_load_fromurl:

• libjwt: proc jwks_load_fromurl(jwk_set: ptr jwk_set_t; url: cstring; verify: cint): ptr jwk_set_t

jwks_load_strn:

• libjwt: proc jwks_load_strn(jwk_set: ptr jwk_set_t; jwk_json_str: cstring; len: csize_t): ptr jwk_set_t

JwsClaims:

• jws: type JwsClaims

JwsHeader:

• jws: object JwsHeader

JwsOptions:

• jws: object JwsOptions

jwt_alg_str:

• libjwt: proc jwt_alg_str(alg: jwt_alg_t): cstring

jwt_alg_t:

• libjwt: enum jwt_alg_t

JwtBuilder:

• api: type JwtBuilder

jwt_builder_claim_del:

• libjwt: proc jwt_builder_claim_del(builder: ptr jwt_builder_t; claim: cstring): jwt_value_error_t

jwt_builder_claim_get:

• libjwt: proc jwt_builder_claim_get(builder: ptr jwt_builder_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_builder_claim_set:

• libjwt: proc jwt_builder_claim_set(builder: ptr jwt_builder_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_builder_enable_iat:

• libjwt: proc jwt_builder_enable_iat(builder: ptr jwt_builder_t; enable: cint): cint

jwt_builder_error:

• libjwt: proc jwt_builder_error(builder: ptr jwt_builder_t): cint

jwt_builder_error_clear:

• libjwt: proc jwt_builder_error_clear(builder: ptr jwt_builder_t)

jwt_builder_error_msg:

• libjwt: proc jwt_builder_error_msg(builder: ptr jwt_builder_t): cstring

jwt_builder_free:

• libjwt: proc jwt_builder_free(builder: ptr jwt_builder_t)

jwt_builder_generate:

• libjwt: proc jwt_builder_generate(builder: ptr jwt_builder_t): cstring

jwt_builder_getctx:

• libjwt: proc jwt_builder_getctx(builder: ptr jwt_builder_t): pointer

jwt_builder_header_del:

• libjwt: proc jwt_builder_header_del(builder: ptr jwt_builder_t; header: cstring): jwt_value_error_t

jwt_builder_header_get:

• libjwt: proc jwt_builder_header_get(builder: ptr jwt_builder_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_builder_header_set:

• libjwt: proc jwt_builder_header_set(builder: ptr jwt_builder_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_builder_new:

• libjwt: proc jwt_builder_new(): ptr jwt_builder_t

jwt_builder_setcb:

• libjwt: proc jwt_builder_setcb(builder: ptr jwt_builder_t; cb: jwt_callback_t; ctx: pointer): cint

jwt_builder_setkey:

• libjwt: proc jwt_builder_setkey(builder: ptr jwt_builder_t; alg: jwt_alg_t; key: ptr jwk_item_t): cint

jwt_builder_t:

• libjwt: object jwt_builder_t

jwt_builder_time_offset:

• libjwt: proc jwt_builder_time_offset(builder: ptr jwt_builder_t; claim: jwt_claims_t; secs: time_t): cint

jwt_callback_t:

• libjwt: type jwt_callback_t

JwtChecker:

• api: type JwtChecker

jwt_checker_claim_del:

• libjwt: proc jwt_checker_claim_del(checker: ptr jwt_checker_t; typ: jwt_claims_t): cint

jwt_checker_claim_get:

• libjwt: proc jwt_checker_claim_get(checker: ptr jwt_checker_t; typ: jwt_claims_t): cstring

jwt_checker_claim_set:

• libjwt: proc jwt_checker_claim_set(checker: ptr jwt_checker_t; typ: jwt_claims_t; value: cstring): cint

jwt_checker_error:

• libjwt: proc jwt_checker_error(checker: ptr jwt_checker_t): cint

jwt_checker_error_clear:

• libjwt: proc jwt_checker_error_clear(checker: ptr jwt_checker_t)

jwt_checker_error_msg:

• libjwt: proc jwt_checker_error_msg(checker: ptr jwt_checker_t): cstring

jwt_checker_free:

• libjwt: proc jwt_checker_free(checker: ptr jwt_checker_t)

jwt_checker_getctx:

• libjwt: proc jwt_checker_getctx(checker: ptr jwt_checker_t): pointer

jwt_checker_new:

• libjwt: proc jwt_checker_new(): ptr jwt_checker_t

jwt_checker_setcb:

• libjwt: proc jwt_checker_setcb(checker: ptr jwt_checker_t; cb: jwt_callback_t; ctx: pointer): cint

jwt_checker_setkey:

• libjwt: proc jwt_checker_setkey(checker: ptr jwt_checker_t; alg: jwt_alg_t; key: ptr jwk_item_t): cint

jwt_checker_t:

• libjwt: object jwt_checker_t

jwt_checker_time_leeway:

• libjwt: proc jwt_checker_time_leeway(checker: ptr jwt_checker_t; claim: jwt_claims_t; secs: time_t): cint

jwt_checker_verify:

• libjwt: proc jwt_checker_verify(checker: ptr jwt_checker_t; token: cstring): cint

jwt_claim_del:

• libjwt: proc jwt_claim_del(jwt: ptr jwt_t; claim: cstring): jwt_value_error_t

jwt_claim_get:

• libjwt: proc jwt_claim_get(jwt: ptr jwt_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_claim_set:

• libjwt: proc jwt_claim_set(jwt: ptr jwt_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_claims_t:

• libjwt: enum jwt_claims_t

jwt_config_t:

• libjwt: object jwt_config_t

jwt_crypto_ops_supports_jwk:

• libjwt: proc jwt_crypto_ops_supports_jwk(): cint

jwt_crypto_provider_t:

• libjwt: enum jwt_crypto_provider_t

JwtError:

• api: object JwtError

jwt_free_t:

• libjwt: type jwt_free_t

jwt_get_alg:

• libjwt: proc jwt_get_alg(jwt: ptr jwt_t): jwt_alg_t

jwt_get_alloc:

• libjwt: proc jwt_get_alloc(pmalloc: ptr jwt_malloc_t; pfree: ptr jwt_free_t)

jwt_get_crypto_ops:

• libjwt: proc jwt_get_crypto_ops(): cstring

jwt_get_crypto_ops_t:

• libjwt: proc jwt_get_crypto_ops_t(): jwt_crypto_provider_t

jwt_header_del:

• libjwt: proc jwt_header_del(jwt: ptr jwt_t; header: cstring): jwt_value_error_t

jwt_header_get:

• libjwt: proc jwt_header_get(jwt: ptr jwt_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_header_set:

• libjwt: proc jwt_header_set(jwt: ptr jwt_t; value: ptr jwt_value_t): jwt_value_error_t

jwt_long_t:

• libjwt: type jwt_long_t

jwt_malloc_t:

• libjwt: type jwt_malloc_t

jwt_set_alloc:

• libjwt: proc jwt_set_alloc(pmalloc: jwt_malloc_t; pfree: jwt_free_t): cint

jwt_set_crypto_ops:

• libjwt: proc jwt_set_crypto_ops(opname: cstring): cint

jwt_set_crypto_ops_t:

• libjwt: proc jwt_set_crypto_ops_t(opname: jwt_crypto_provider_t): cint

jwt_set_GET_BOOL:

• libjwt: template jwt_set_GET_BOOL(v: var jwt_value_t; n: cstring)

jwt_set_GET_INT:

• libjwt: template jwt_set_GET_INT(v: var jwt_value_t; n: cstring)

jwt_set_GET_JSON:

• libjwt: template jwt_set_GET_JSON(v: var jwt_value_t; n: cstring)

jwt_set_GET_STR:

• libjwt: template jwt_set_GET_STR(v: var jwt_value_t; n: cstring)

jwt_str_alg:

• libjwt: proc jwt_str_alg(alg: cstring): jwt_alg_t

jwt_t:

• libjwt: object jwt_t

JWTValue:

• libjwt: type JWTValue

jwt_value_error_t:

• libjwt: enum jwt_value_error_t

jwtValueSetBool:

• libjwt: proc jwtValueSetBool(name: cstring; value: cint): jwt_value_t

jwtValueSetInt:

• libjwt: proc jwtValueSetInt(name: cstring; value: jwt_long_t): jwt_value_t

jwtValueSetJson:

• libjwt: proc jwtValueSetJson(name: cstring; value: cstring): jwt_value_t

jwtValueSetStr:

• libjwt: proc jwtValueSetStr(name: cstring; value: cstring): jwt_value_t

jwt_value_t:

• libjwt: object jwt_value_t

jwt_value_type_t:

• libjwt: enum jwt_value_type_t

loadJwkSetFromFile:

• api: proc loadJwkSetFromFile(path: string): JwkSet

loadJwkSetFromJson:

• api: proc loadJwkSetFromJson(jsonStr: string): JwkSet

loadJwkSetFromUrl:

• api: proc loadJwkSetFromUrl(url: string; verifyTls: bool = true): JwkSet

newJwtBuilder:

• api: proc newJwtBuilder(): JwtBuilder

newJwtChecker:

• api: proc newJwtChecker(): JwtChecker

parseAlg:

• api: proc parseAlg(s: string): Alg

parsePayloadJson:

• api: proc parsePayloadJson(token: string): JsonNode

raiseBuilder:

• api: proc raiseBuilder(b: JwtBuilder; ctx: string)

raiseChecker:

• api: proc raiseChecker(c: JwtChecker; ctx: string)

raiseJwk:

• api: proc raiseJwk(s: JwkSet; ctx: string)

resolveKey:

• jws: proc resolveKey(set: JwkSet; header: JwsHeader): tuple[alg: Alg, key: JwkItem]

setAud:

• api: proc setAud(b: JwtBuilder; aud: string | seq[string])
• api: proc setAud(b: JwtBuilder; aud: openArray[string])
• api: proc setAud(b: JwtBuilder; aud: string)

setClaim:

• api: proc setClaim(b: JwtBuilder; name: string; value: bool)
• api: proc setClaim(b: JwtBuilder; name: string; value: int64)
• api: proc setClaim(b: JwtBuilder; name: string; value: string)

setClaimJson:

• api: proc setClaimJson(b: JwtBuilder; name: string; value: JsonNode)

setCryptoProvider:

• api: proc setCryptoProvider(prov: CryptoProvider)
• api: proc setCryptoProvider(name: string)

setExp:

• api: proc setExp(b: JwtBuilder; exp: Time)

setExpIn:

• api: proc setExpIn(b: JwtBuilder; seconds: int64)

setHeader:

• api: proc setHeader(b: JwtBuilder; name: string; value: bool)
• api: proc setHeader(b: JwtBuilder; name: string; value: int64)
• api: proc setHeader(b: JwtBuilder; name: string; value: string)

setHeaderJson:

• api: proc setHeaderJson(b: JwtBuilder; name: string; value: JsonNode)

setIat:

• api: proc setIat(b: JwtBuilder; iat: Time = getTime())

setIss:

• api: proc setIss(b: JwtBuilder; iss: string)

setJti:

• api: proc setJti(b: JwtBuilder; jti: string)

setKey:

• api: proc setKey(b: JwtBuilder; alg: Alg; key: JwkItem)
• api: proc setKey(c: JwtChecker; alg: Alg; key: JwkItem)

setLeeway:

• api: proc setLeeway(c: JwtChecker; claim: ClaimKind; seconds: int64)

setNbf:

• api: proc setNbf(b: JwtBuilder; nbf: Time)

setSub:

• api: proc setSub(b: JwtBuilder; sub: string)

sign:

• jws: proc sign(set: JwkSet; header: JwsHeader; claims: JwsClaims; opt: JwsOptions = JwsOptions()): string

sub:

• api: proc sub(c: JwtChecker): string

timeOffset:

• api: proc timeOffset(b: JwtBuilder; claim: ClaimKind; seconds: int64)

time_t:

• libjwt: type time_t

toEpoch:

• api: proc toEpoch(t: Time): int64

verify:

• api: proc verify(c: JwtChecker; token: string): bool
• jws: proc verify(set: JwkSet; header: JwsHeader; token: string; opt: JwsOptions = JwsOptions()): JsonNode