Class export=

The wire format of Kerberos FAST (RFC 6113), OTP pre-authentication (RFC 6560) and authentication indicators (RFC 7751, RFC 8129): structures to DER and back, built on the vendored codec's primitives.

It knows no key and no policy; a structure that does not decode throws. A static utility class.

Constructors

constructor

new "export="(): export=

Returns export=

Properties

`Static` `Readonly`AD

AD: {
    AUTHENTICATION_INDICATOR: number;
    CAMMAC: number;
    FX_FAST_ARMOR: number;
    FX_FAST_USED: number;
    IF_RELEVANT: number;
} = ...

The authorization data types: AD-IF-RELEVANT, RFC 6113's two FAST markers, AD-CAMMAC and AD-AUTHENTICATION-INDICATOR.

`Static` `Readonly`ARMOR_AP_REQUEST

ARMOR_AP_REQUEST: 1

The one FAST armor type defined, an AP-REQ (RFC 6113 section 5.4.1).

`Static` `Readonly`ERROR

ERROR: {
    INVALID_HASH_ALG: number;
    INVALID_ITERATION_COUNT: number;
    MORE_PREAUTH_DATA_REQUIRED: number;
    PIN_EXPIRED: number;
    PIN_REQUIRED: number;
    PREAUTH_BAD_AUTHENTICATION_SET: number;
    PREAUTH_EXPIRED: number;
    UNKNOWN_CRITICAL_FAST_OPTIONS: number;
} = ...

The error codes of RFC 6113 section 6.1 and RFC 6560 section 2.3.

`Static` `Readonly`FAST_OPTION

FAST_OPTION: {
    HIDE_CLIENT_NAMES: number;
    KDC_FOLLOW_REFERRALS: number;
    RESERVED: number;
} = ...

The FastOptions bits (RFC 6113 section 5.4.2); bits 0 to 15 are critical.

`Static` `Readonly`KEY_USAGE

KEY_USAGE: {
    CAMMAC: number;
    ENC_CHALLENGE_CLIENT: number;
    ENC_CHALLENGE_KDC: number;
    FAST_ENC: number;
    FAST_FINISHED: number;
    FAST_REP: number;
    FAST_REQ_CHKSUM: number;
    FX_COOKIE: number;
    OTP_REQUEST: number;
} = ...

The key usages: RFC 6560's, RFC 6113's, RFC 7751's, and MIT's private usage for the PA-FX-COOKIE.

`Static` `Readonly`OTP_FLAG

OTP_FLAG: {
    CHECK_DIGIT: number;
    COLLECT_PIN: number;
    COMBINE: number;
    DO_NOT_COLLECT_PIN: number;
    MUST_ENCRYPT_NONCE: number;
    NEXT_OTP: number;
    SEPARATE_PIN_REQUIRED: number;
} = ...

The OTPFlags bits (RFC 6560 section 4.1), numbered from the most significant bit.

`Static` `Readonly`OTP_FORMAT

OTP_FORMAT: {
    ALPHANUMERIC: number;
    BASE64: number;
    BINARY: number;
    DECIMAL: number;
    HEXADECIMAL: number;
} = ...

The otp-format values (RFC 6560).

`Static` `Readonly`PA

PA: {
    AUTH_SET_SELECTED: number;
    AUTHENTICATION_SET: number;
    ENCRYPTED_CHALLENGE: number;
    FX_COOKIE: number;
    FX_ERROR: number;
    FX_FAST: number;
    OTP_CHALLENGE: number;
    OTP_PIN_CHANGE: number;
    OTP_REQUEST: number;
} = ...

The padata types of RFC 6113 section 6.4 and RFC 6560 section 5.

Methods

`Static`asUniversal

asUniversal(t: any, tag: number): any
Reads an implicitly tagged TLV back as the universal type it replaces.
Parameters
- t: any
  the context-tagged TLV
- tag: number
  the universal tag to read it as
Returns any
the TLV
- Defined in kerberos/krb5_fast_codec.ts:588

`Static`decUtf8

decUtf8(t: any): string
Decodes a UTF8String.
Parameters
- t: any
  the decoded TLV
Returns string
the text

Throws
Error when the TLV is not a UTF8String
- Defined in kerberos/krb5_fast_codec.ts:195

`Static`encArmor

encArmor(armor: any): Uint8Array
Encodes a KrbFastArmor.
Parameters
- armor: any
  { type, value }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:313

`Static`encCammac

encCammac(c: any): Uint8Array
Encodes an AD-CAMMAC around the already-encoded AuthorizationData its verifiers' MACs cover.
Parameters
- c: any
  { elementsBytes, kdcVerifier, svcVerifier }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:960

`Static`encFastFinished

encFastFinished(fin: any): Uint8Array
Encodes a KrbFastFinished.
Parameters
- fin: any
  { timestamp, usec, crealm, cname, ticketChecksum }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:513

`Static`encFastReply

encFastReply(encFastRep: any): Uint8Array
Encodes a PA-FX-FAST-REPLY around the encrypted KrbFastResponse.
Parameters
- encFastRep: any
  the EncryptedData
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:436

`Static`encFastReq

encFastReq(req: any): Uint8Array
Encodes a KrbFastReq; a reqBody carrying its raw bytes is placed as they are.
Parameters
- req: any
  { fastOptions, padata, reqBody }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:393

`Static`encFastRequest

encFastRequest(req: any): Uint8Array
Encodes a PA-FX-FAST-REQUEST, a KrbFastArmoredReq in its [0] alternative.
Parameters
- req: any
  { armor, reqChecksum, encFastReq }, armor optional
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:352

`Static`encFastResponse

encFastResponse(rep: any): Uint8Array
Encodes a KrbFastResponse.
Parameters
- rep: any
  { padata, strengthenKey, finished, nonce }, the middle two optional
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:470

`Static`encIndicators

encIndicators(list: string[]): Uint8Array
Encodes an AD-AUTHENTICATION-INDICATOR.
Parameters
- list: string[]
  the indicators
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:1000

`Static`encOtpChallenge

encOtpChallenge(chl: any): Uint8Array
Encodes a PA-OTP-CHALLENGE, every tag implicit.
Parameters
- chl: any
  { nonce, service, tokenInfo, salt, s2kparams }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:693

`Static`encOtpEncRequest

encOtpEncRequest(nonce: Uint8Array): Uint8Array
Encodes a PA-OTP-ENC-REQUEST.
Parameters
- nonce: Uint8Array
  the nonce
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:861

`Static`encOtpRequest

encOtpRequest(req: any): Uint8Array
Encodes a PA-OTP-REQUEST, every tag implicit.
Parameters
- req: any
  { flags, nonce, encData, value, pin, time, vendor }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:801

`Static`encPadataList

encPadataList(list: any[]): Uint8Array
Encodes a SEQUENCE OF PA-DATA.
Parameters
- list: any[]
  the PA-DATA
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:297

`Static`encTokenInfo

encTokenInfo(ti: any): Uint8Array
Encodes an OTP-TOKENINFO; the two hashing fields are never written.
Parameters
- ti: any
  { flags, vendor, challenge, length, format, tokenId, algId }
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:743

`Static`encUtf8

encUtf8(text: string): Uint8Array
Encodes a UTF8String.
Parameters
- text: string
  the text
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:181

`Static`encVerifierMac

encVerifierMac(v: any): Uint8Array
Encodes a Verifier-MAC.
Parameters
- v: any
  { identifier, kvno, enctype, mac }, all but mac optional
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:917

`Static`explicit

explicit(bytes: Uint8Array, n: number): any
Returns the one element inside an explicit context tag [n], which is how a CHOICE alternative arrives.
Parameters
- bytes: Uint8Array
  the DER
- n: number
  the context tag number
Returns any
the inner TLV

Throws
Error unless it is exactly [n] round one element
- Defined in kerberos/krb5_fast_codec.ts:219

`Static`fieldsOf

fieldsOf(t: any, what: string): any
Returns a SEQUENCE's context-tagged fields, by tag number.
Parameters
- t: any
  the SEQUENCE's TLV
- what: string
  the structure's name, for the error
Returns any
the fields

Throws
Error when it is not a SEQUENCE
- Defined in kerberos/krb5_fast_codec.ts:248

`Static`find

find(list: any[], type: number): any
Returns the PA-DATA of a type in a list.
Parameters
- list: any[]
  the PA-DATA
- type: number
  the padata type
Returns any
the PA-DATA, or null
- Defined in kerberos/krb5_fast_codec.ts:1028

`Static`iInt

iInt(n: number, value: number): Uint8Array<ArrayBufferLike>
Encodes an implicitly tagged INTEGER field.
Parameters
- n: number
  the context tag number
- value: number
  the integer
Returns Uint8Array<ArrayBufferLike>
the TLV, or null when absent
- Defined in kerberos/krb5_fast_codec.ts:662

`Static`implicit

implicit(
n: number,
encoded: Uint8Array<ArrayBufferLike>,
): Uint8Array<ArrayBufferLike>
Turns an encoded universal TLV into its implicitly context-tagged form [n], the constructed bit kept.
Parameters
- n: number
  the context tag number
- encoded: Uint8Array<ArrayBufferLike>
  the universal TLV
Returns Uint8Array<ArrayBufferLike>
the retagged TLV, or null for null
- Defined in kerberos/krb5_fast_codec.ts:569

`Static`implicitFields

implicitFields(t: any, what: string): any
Returns the fields of an implicitly tagged SEQUENCE, by context tag number.
Parameters
- t: any
  the SEQUENCE's TLV
- what: string
  the structure's name, for the error
Returns any
the fields

Throws
Error when it is not a SEQUENCE or a field is not context-tagged
- Defined in kerberos/krb5_fast_codec.ts:605

`Static`implicitSequence

implicitSequence(fields: Uint8Array<ArrayBufferLike>[]): Uint8Array
Encodes a SEQUENCE of the fields that are present.
Parameters
- fields: Uint8Array<ArrayBufferLike>[]
  the encoded fields, null for absent
Returns Uint8Array
the DER
- Defined in kerberos/krb5_fast_codec.ts:675

`Static`iOctets

iOctets(
n: number,
value: Uint8Array<ArrayBufferLike>,
): Uint8Array<ArrayBufferLike>
Encodes an implicitly tagged OCTET STRING field.
Parameters
- n: number
  the context tag number
- value: Uint8Array<ArrayBufferLike>
  the bytes
Returns Uint8Array<ArrayBufferLike>
the TLV, or null when absent
- Defined in kerberos/krb5_fast_codec.ts:634

`Static`iUtf8

iUtf8(n: number, value: string): Uint8Array<ArrayBufferLike>
Encodes an implicitly tagged UTF8String field.
Parameters
- n: number
  the context tag number
- value: string
  the text
Returns Uint8Array<ArrayBufferLike>
the TLV, or null when absent
- Defined in kerberos/krb5_fast_codec.ts:648

`Static`padataList

padataList(t: any): any[]
Decodes a SEQUENCE OF PA-DATA.
Parameters
- t: any
  the SEQUENCE's TLV
Returns any[]
the PA-DATA
- Defined in kerberos/krb5_fast_codec.ts:285

`Static`readArmor

readArmor(t: any): any
Decodes a KrbFastArmor.
Parameters
- t: any
  the SEQUENCE's TLV
Returns any
{ type, value }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:329

`Static`readCammac

readCammac(bytes: Uint8Array): any
Decodes an AD-CAMMAC, keeping the elements' bytes for checking the MACs.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ elementsBytes, elements, kdcVerifier, svcVerifier }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:979

`Static`readFastFinished

readFastFinished(t: any): any
Decodes a KrbFastFinished.
Parameters
- t: any
  the SEQUENCE's TLV
Returns any
{ timestamp, usec, crealm, cname, ticketChecksum }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:532

`Static`readFastReply

readFastReply(bytes: Uint8Array): any
Decodes a PA-FX-FAST-REPLY.
Parameters
- bytes: Uint8Array
  the DER
Returns any
the EncryptedData

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:451

`Static`readFastReq

readFastReq(bytes: Uint8Array): any
Decodes a KrbFastReq, the req-body with the vendored KDC-REQ-BODY reader.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ fastOptions, padata, reqBody }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:411

`Static`readFastRequest

readFastRequest(bytes: Uint8Array): any
Decodes a PA-FX-FAST-REQUEST.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ armor, reqChecksum, encFastReq }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:369

`Static`readFastResponse

readFastResponse(bytes: Uint8Array): any
Decodes a KrbFastResponse.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ padata, strengthenKey, finished, nonce }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:490

`Static`readIndicators

readIndicators(bytes: Uint8Array): string[]
Decodes an AD-AUTHENTICATION-INDICATOR.
Parameters
- bytes: Uint8Array
  the DER
Returns string[]
the indicators

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:1013

`Static`readOtpChallenge

readOtpChallenge(bytes: Uint8Array): any
Decodes a PA-OTP-CHALLENGE.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ nonce, service, tokenInfo, salt, s2kparams }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:714

`Static`readOtpEncData

readOtpEncData(bytes: Uint8Array): any
Decodes what an OTP request's encData opened to: a PA-OTP-ENC-REQUEST (four-pass) or a PA-ENC-TS-ENC (two-pass), told apart by field 0's tag.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ nonce } or { timestamp }

Throws
Error when it is neither
- Defined in kerberos/krb5_fast_codec.ts:880

`Static`readOtpRequest

readOtpRequest(bytes: Uint8Array): any
Decodes a PA-OTP-REQUEST; hashing is true for a hashAlg or an iterationCount above zero.
Parameters
- bytes: Uint8Array
  the DER
Returns any
{ flags, nonce, encData, hashing, value, pin, time, vendor }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:826

`Static`readTokenInfo

readTokenInfo(t: any): any
Decodes an OTP-TOKENINFO.
Parameters
- t: any
  the SEQUENCE's TLV
Returns any
{ flags, vendor, challenge, length, format, tokenId, algId, hashing }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:765

`Static`readVerifierMac

readVerifierMac(t: any): any
Decodes a Verifier-MAC.
Parameters
- t: any
  the SEQUENCE's TLV
Returns any
{ identifier, kvno, enctype, mac }

Throws
Error when it does not decode
- Defined in kerberos/krb5_fast_codec.ts:938

`Static`required

required(f: any, n: number, what: string): any
Returns a required field of a decoded SEQUENCE.
Parameters
- f: any
  the fields, by tag number
- n: number
  the tag number
- what: string
  the structure's name, for the error
Returns any
the field

Throws
Error when the field is absent
- Defined in kerberos/krb5_fast_codec.ts:268

Class export=

Index

Constructors

Properties

Methods

Constructors

constructor

Returns export=

Properties

Static ReadonlyAD

Static ReadonlyARMOR_AP_REQUEST

Static ReadonlyERROR

Static ReadonlyFAST_OPTION

Static ReadonlyKEY_USAGE

Static ReadonlyOTP_FLAG

Static ReadonlyOTP_FORMAT

Static ReadonlyPA

Methods

StaticasUniversal

Parameters

Returns any

StaticdecUtf8

Parameters

Returns string

Throws

StaticencArmor

Parameters

Returns Uint8Array

StaticencCammac

Parameters

Returns Uint8Array

StaticencFastFinished

Parameters

Returns Uint8Array

StaticencFastReply

Parameters

Returns Uint8Array

StaticencFastReq

Parameters

Returns Uint8Array

StaticencFastRequest

Parameters

Returns Uint8Array

StaticencFastResponse

Parameters

Returns Uint8Array

StaticencIndicators

Parameters

Returns Uint8Array

StaticencOtpChallenge

Parameters

Returns Uint8Array

StaticencOtpEncRequest

Parameters

Returns Uint8Array

StaticencOtpRequest

Parameters

Returns Uint8Array

StaticencPadataList

Parameters

Returns Uint8Array

StaticencTokenInfo

Parameters

Returns Uint8Array

StaticencUtf8

Parameters

Returns Uint8Array

StaticencVerifierMac

Parameters

Returns Uint8Array

Staticexplicit

Parameters

Returns any

Throws

StaticfieldsOf

Parameters

Returns any

Throws

Staticfind

Parameters

`Static` `Readonly`AD

`Static` `Readonly`ARMOR_AP_REQUEST

`Static` `Readonly`ERROR

`Static` `Readonly`FAST_OPTION

`Static` `Readonly`KEY_USAGE

`Static` `Readonly`OTP_FLAG

`Static` `Readonly`OTP_FORMAT

`Static` `Readonly`PA

`Static`asUniversal

`Static`decUtf8

`Static`encArmor

`Static`encCammac

`Static`encFastFinished

`Static`encFastReply

`Static`encFastReq

`Static`encFastRequest

`Static`encFastResponse

`Static`encIndicators

`Static`encOtpChallenge

`Static`encOtpEncRequest

`Static`encOtpRequest

`Static`encPadataList

`Static`encTokenInfo

`Static`encUtf8

`Static`encVerifierMac

`Static`explicit

`Static`fieldsOf

`Static`find

`Static`iInt

`Static`implicit

`Static`implicitFields

`Static`implicitSequence

`Static`iOctets

`Static`iUtf8

`Static`padataList

`Static`readArmor

`Static`readCammac

`Static`readFastFinished

`Static`readFastReply

`Static`readFastReq

`Static`readFastRequest

`Static`readFastResponse

`Static`readIndicators

`Static`readOtpChallenge

`Static`readOtpEncData

`Static`readOtpRequest

`Static`readTokenInfo