From 43d4a20518346232aaae634933286881ffe3d52a Mon Sep 17 00:00:00 2001 From: dmihalcik-virtru Date: Mon, 29 Apr 2024 14:45:11 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20opentdf/?= =?UTF-8?q?client-web@ec5803179d6bbd9e2e3a366177d377d3128d5f81=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/AuthProviders.AppIdAuthProvider.html | 6 +- classes/AuthProviders.AuthProvider.html | 6 +- classes/AuthProviders.HttpRequest.html | 14 ++-- ...oviders.OIDCClientCredentialsProvider.html | 10 +-- ...AuthProviders.OIDCExternalJwtProvider.html | 12 ++-- ...uthProviders.OIDCRefreshTokenProvider.html | 12 ++-- classes/NanoTDFClient.html | 52 +++++++------- classes/NanoTDFDatasetClient.html | 68 +++++++++---------- .../AuthProviders.clientAuthProvider.html | 2 +- ...uthProviders.clientSecretAuthProvider.html | 2 +- .../AuthProviders.externalAuthProvider.html | 2 +- .../AuthProviders.refreshAuthProvider.html | 2 +- functions/AuthProviders.reqSignature.html | 2 +- functions/AuthProviders.withHeaders.html | 2 +- modules/AuthProviders.html | 2 +- types/AuthProviders.HttpMethod.html | 2 +- variables/clientType.html | 2 +- variables/version.html | 2 +- 18 files changed, 100 insertions(+), 100 deletions(-) diff --git a/classes/AuthProviders.AppIdAuthProvider.html b/classes/AuthProviders.AppIdAuthProvider.html index 0c9fe731..63953815 100644 --- a/classes/AuthProviders.AppIdAuthProvider.html +++ b/classes/AuthProviders.AppIdAuthProvider.html @@ -38,7 +38,7 @@

Hierarchy

+
  • Defined in auth/auth.ts:124
    • @@ -70,7 +70,7 @@

    Abstract

    Returns string

    +
  • Defined in auth/auth.ts:132

    • Abstract withCreds

    +
  • Defined in auth/auth.ts:130
    • diff --git a/classes/AuthProviders.AuthProvider.html b/classes/AuthProviders.AuthProvider.html index 38577932..8c442302 100644 --- a/classes/AuthProviders.AuthProvider.html +++ b/classes/AuthProviders.AuthProvider.html @@ -35,7 +35,7 @@

    Implemented by

  • OIDCExternalJwtProvider
  • OIDCRefreshTokenProvider
    • +
  • Defined in auth/auth.ts:83
    • @@ -89,7 +89,7 @@
    Optional Returns Promise<void>
    +
  • Defined in auth/auth.ts:97

    • Abstract withCreds

    +
  • Defined in auth/auth.ts:104
    • diff --git a/classes/AuthProviders.HttpRequest.html b/classes/AuthProviders.HttpRequest.html index ade21345..bb30f709 100644 --- a/classes/AuthProviders.HttpRequest.html +++ b/classes/AuthProviders.HttpRequest.html @@ -25,7 +25,7 @@

    Hierarchy

    • HttpRequest
    +
  • Defined in auth/auth.ts:17
    • @@ -52,34 +52,34 @@

    constructor

    Returns HttpRequest

    +
  • Defined in auth/auth.ts:28

    • Properties

    Optional body

    body?: unknown
    +
  • Defined in auth/auth.ts:26

    • headers

    headers: Record<string, string>
    +
  • Defined in auth/auth.ts:18

    • method

    method: HttpMethod
    +
  • Defined in auth/auth.ts:20

    • Optional params

    params?: object
    +
  • Defined in auth/auth.ts:22

    • url

    url: string
    +
  • Defined in auth/auth.ts:24
    • diff --git a/classes/AuthProviders.OIDCClientCredentialsProvider.html b/classes/AuthProviders.OIDCClientCredentialsProvider.html index 65893156..2508bbfe 100644 --- a/classes/AuthProviders.OIDCClientCredentialsProvider.html +++ b/classes/AuthProviders.OIDCClientCredentialsProvider.html @@ -33,7 +33,7 @@

    Implements

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:4
    • @@ -66,14 +66,14 @@

    Parameters

    __namedParameters: Partial<ClientSecretCredentials> & Omit<ClientSecretCredentials, "exchange">

    Returns OIDCClientCredentialsProvider

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:7

    • Properties

    oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-clientcredentials-provider.ts:5

    • Methods

    @@ -106,7 +106,7 @@

    Returns Promise<

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:26

    • withCreds

    +
  • Defined in auth/oidc-clientcredentials-provider.ts:30
    • diff --git a/classes/AuthProviders.OIDCExternalJwtProvider.html b/classes/AuthProviders.OIDCExternalJwtProvider.html index 66aaa52c..b8ebe389 100644 --- a/classes/AuthProviders.OIDCExternalJwtProvider.html +++ b/classes/AuthProviders.OIDCExternalJwtProvider.html @@ -33,7 +33,7 @@

    Implements

    +
  • Defined in auth/oidc-externaljwt-provider.ts:4
    • @@ -67,19 +67,19 @@

    Parameters

    __namedParameters: Partial<ExternalJwtCredentials> & Omit<ExternalJwtCredentials, "exchange">

    Returns OIDCExternalJwtProvider

    +
  • Defined in auth/oidc-externaljwt-provider.ts:8

    • Properties

    Optional externalJwt

    externalJwt?: string
    +
  • Defined in auth/oidc-externaljwt-provider.ts:6

    • oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-externaljwt-provider.ts:5

    • Methods

    @@ -112,7 +112,7 @@

    Returns Promise<

    +
  • Defined in auth/oidc-externaljwt-provider.ts:29

    • withCreds

    +
  • Defined in auth/oidc-externaljwt-provider.ts:33
    • diff --git a/classes/AuthProviders.OIDCRefreshTokenProvider.html b/classes/AuthProviders.OIDCRefreshTokenProvider.html index 6c59bb1f..fa977724 100644 --- a/classes/AuthProviders.OIDCRefreshTokenProvider.html +++ b/classes/AuthProviders.OIDCRefreshTokenProvider.html @@ -33,7 +33,7 @@

    Implements

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:4
    • @@ -67,19 +67,19 @@

    Parameters

    __namedParameters: Partial<RefreshTokenCredentials> & Omit<RefreshTokenCredentials, "exchange">

    Returns OIDCRefreshTokenProvider

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:8

    • Properties

    oidcAuth

    oidcAuth: AccessToken
    +
  • Defined in auth/oidc-refreshtoken-provider.ts:5

    • Optional refreshToken

    refreshToken?: string
    +
  • Defined in auth/oidc-refreshtoken-provider.ts:6

    • Methods

    @@ -112,7 +112,7 @@

    Returns Promise<

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:28

    • withCreds

    +
  • Defined in auth/oidc-refreshtoken-provider.ts:32
    • diff --git a/classes/NanoTDFClient.html b/classes/NanoTDFClient.html index 8e5e12b1..44feb6f1 100644 --- a/classes/NanoTDFClient.html +++ b/classes/NanoTDFClient.html @@ -29,7 +29,7 @@

    Hierarchy

    • NanoTDFClient
    +
  • Defined in index.ts:52
    • @@ -96,7 +96,7 @@

    Returns

    +
  • Defined in nanotdf/Client.ts:78

    • Properties

    @@ -104,91 +104,91 @@

    allowedKasesallowedKases: string[]

    +
  • Defined in nanotdf/Client.ts:56

    • Readonly authProvider

    authProvider: AuthProvider
    +
  • Defined in nanotdf/Client.ts:63

    • dataAttributes

    dataAttributes: string[] = []
    +
  • Defined in nanotdf/Client.ts:66

    • dissems

    dissems: string[] = []
    +
  • Defined in nanotdf/Client.ts:65

    • Readonly dpopEnabled

    dpopEnabled: boolean
    +
  • Defined in nanotdf/Client.ts:64

    • Protected Optional ephemeralKeyPair

    ephemeralKeyPair?: Required<Readonly<CryptoKeyPair>>
    +
  • Defined in nanotdf/Client.ts:67

    • Protected Optional iv

    iv?: number
    +
  • Defined in nanotdf/Client.ts:69

    • Protected kasPubKey

    kasPubKey: string
    +
  • Defined in nanotdf/Client.ts:62

    • Protected kasUrl

    kasUrl: string
    +
  • Defined in nanotdf/Client.ts:61

    • Protected Optional requestSignerKeyPair

    requestSignerKeyPair?: Required<Readonly<CryptoKeyPair>>
    +
  • Defined in nanotdf/Client.ts:68

    • Static Readonly INITIAL_RELEASE_IV_SIZE

    INITIAL_RELEASE_IV_SIZE: 3 = 3
    +
  • Defined in nanotdf/Client.ts:53

    • Static Readonly IV_SIZE

    IV_SIZE: 12 = 12
    +
  • Defined in nanotdf/Client.ts:54

    • Static Readonly KAS_PROTOCOL

    KAS_PROTOCOL: "kas" = 'kas'
    +
  • Defined in nanotdf/Client.ts:51

    • Static Readonly KEY_ACCESS_REMOTE

    KEY_ACCESS_REMOTE: "remote" = 'remote'
    +
  • Defined in nanotdf/Client.ts:50

    • Static Readonly SDK_INITIAL_RELEASE

    SDK_INITIAL_RELEASE: "0.0.0" = '0.0.0'
    +
  • Defined in nanotdf/Client.ts:52

    • Methods

    @@ -210,7 +210,7 @@

    Returns void

    +
  • Defined in nanotdf/Client.ts:138

    • decrypt

      @@ -230,7 +230,7 @@
      ciphertext: Returns Promise<ArrayBuffer>
    +
  • Defined in index.ts:60

    • decryptLegacyTDF

      @@ -250,7 +250,7 @@
      ciphertext: Returns Promise<ArrayBuffer>
    +
  • Defined in index.ts:91

    • encrypt

      @@ -270,7 +270,7 @@
      data: Returns Promise<ArrayBuffer>
    +
  • Defined in index.ts:121

    • fetchOIDCToken

      @@ -290,7 +290,7 @@

      Performance

      key pair is generated when the entity object is fetched I

    +
  • Defined in nanotdf/Client.ts:153

    • generateEphemeralKeyPair

      @@ -299,7 +299,7 @@

      generateEphemeralKeyPairReturns Promise<Required<Readonly<CryptoKeyPair>>>

    +
  • Defined in nanotdf/Client.ts:109

    • generateSignerKeyPair

      @@ -308,7 +308,7 @@

      generateSignerKeyPair

      Returns Promise<Required<Readonly<CryptoKeyPair>>>

    +
  • Defined in nanotdf/Client.ts:119

    • getEphemeralKeyPair

      @@ -323,7 +323,7 @@

      Security

      allow returning ephemeral key pair has unknown security risk

    +
  • Defined in nanotdf/Client.ts:105

    • rewrapKey

    +
  • Defined in nanotdf/Client.ts:187
    • diff --git a/classes/NanoTDFDatasetClient.html b/classes/NanoTDFDatasetClient.html index cdc0c55d..3deca305 100644 --- a/classes/NanoTDFDatasetClient.html +++ b/classes/NanoTDFDatasetClient.html @@ -29,7 +29,7 @@

    Hierarchy

    • NanoTDFDatasetClient
    +
  • Defined in index.ts:202
    • @@ -113,7 +113,7 @@

    Returns

    +
  • Defined in index.ts:226

    • Properties

    @@ -121,126 +121,126 @@

    allowedKasesallowedKases: string[]

    +
  • Defined in nanotdf/Client.ts:56

    • Readonly authProvider

    authProvider: AuthProvider
    +
  • Defined in nanotdf/Client.ts:63

    • Private Optional cachedEphemeralKey

    cachedEphemeralKey?: Uint8Array
    +
  • Defined in index.ts:209

    • Private Optional cachedHeader

    cachedHeader?: default
    +
  • Defined in index.ts:212

    • dataAttributes

    dataAttributes: string[] = []
    +
  • Defined in nanotdf/Client.ts:66

    • dissems

    dissems: string[] = []
    +
  • Defined in nanotdf/Client.ts:65

    • Readonly dpopEnabled

    dpopEnabled: boolean
    +
  • Defined in nanotdf/Client.ts:64

    • Protected Optional ephemeralKeyPair

    ephemeralKeyPair?: Required<Readonly<CryptoKeyPair>>
    +
  • Defined in nanotdf/Client.ts:67

    • Protected Optional iv

    iv?: number
    +
  • Defined in nanotdf/Client.ts:69

    • Protected kasPubKey

    kasPubKey: string
    +
  • Defined in nanotdf/Client.ts:62

    • Protected kasUrl

    kasUrl: string
    +
  • Defined in nanotdf/Client.ts:61

    • Private keyIterationCount

    keyIterationCount: number
    +
  • Defined in index.ts:208

    • Private maxKeyIteration

    maxKeyIteration: number
    +
  • Defined in index.ts:207

    • Protected Optional requestSignerKeyPair

    requestSignerKeyPair?: Required<Readonly<CryptoKeyPair>>
    +
  • Defined in nanotdf/Client.ts:68

    • Private Optional symmetricKey

    symmetricKey?: CryptoKey
    +
  • Defined in index.ts:211

    • Private Optional unwrappedKey

    unwrappedKey?: CryptoKey
    +
  • Defined in index.ts:210

    • Static Readonly INITIAL_RELEASE_IV_SIZE

    INITIAL_RELEASE_IV_SIZE: 3 = 3
    +
  • Defined in nanotdf/Client.ts:53

    • Static Readonly IV_SIZE

    IV_SIZE: 12 = 12
    +
  • Defined in nanotdf/Client.ts:54

    • Static Readonly KAS_PROTOCOL

    KAS_PROTOCOL: "kas" = 'kas'
    +
  • Defined in nanotdf/Client.ts:51

    • Static Readonly KEY_ACCESS_REMOTE

    KEY_ACCESS_REMOTE: "remote" = 'remote'
    +
  • Defined in nanotdf/Client.ts:50

    • Static Readonly NTDF_MAX_KEY_ITERATIONS

    NTDF_MAX_KEY_ITERATIONS: 8388606 = 8388606
    +
  • Defined in index.ts:205

    • Static Readonly SDK_INITIAL_RELEASE

    SDK_INITIAL_RELEASE: "0.0.0" = '0.0.0'
    +
  • Defined in nanotdf/Client.ts:52

    • Methods

    @@ -262,7 +262,7 @@

    Returns void

    +
  • Defined in nanotdf/Client.ts:138

    • decrypt

    +
  • Defined in index.ts:334

    • encrypt

    +
  • Defined in index.ts:249

    • fetchOIDCToken

    +
  • Defined in nanotdf/Client.ts:153

    • generateEphemeralKeyPair

    +
  • Defined in nanotdf/Client.ts:109

    • generateIV

    +
  • Defined in index.ts:380

    • generateSignerKeyPair

    +
  • Defined in nanotdf/Client.ts:119

    • getEphemeralKeyPair

    +
  • Defined in nanotdf/Client.ts:105

    • rewrapAndDecrypt

    Returns Promise<ArrayBuffer>

    +
  • Defined in index.ts:356

    • rewrapKey

    +
  • Defined in nanotdf/Client.ts:187
    • diff --git a/functions/AuthProviders.clientAuthProvider.html b/functions/AuthProviders.clientAuthProvider.html index c4439689..45b20165 100644 --- a/functions/AuthProviders.clientAuthProvider.html +++ b/functions/AuthProviders.clientAuthProvider.html @@ -34,7 +34,7 @@

    Returns Promise<

    +
  • Defined in auth/providers.ts:97
    • diff --git a/functions/AuthProviders.clientSecretAuthProvider.html b/functions/AuthProviders.clientSecretAuthProvider.html index 8aa12385..cb1f88ba 100644 --- a/functions/AuthProviders.clientSecretAuthProvider.html +++ b/functions/AuthProviders.clientSecretAuthProvider.html @@ -40,7 +40,7 @@
    clientConfig: Returns Promise<OIDCClientCredentialsProvider>
    +
  • Defined in auth/providers.ts:31
    • diff --git a/functions/AuthProviders.externalAuthProvider.html b/functions/AuthProviders.externalAuthProvider.html index 406db14f..8608a1b1 100644 --- a/functions/AuthProviders.externalAuthProvider.html +++ b/functions/AuthProviders.externalAuthProvider.html @@ -39,7 +39,7 @@
    clientConfig: Returns Promise<OIDCExternalJwtProvider>
    +
  • Defined in auth/providers.ts:57
    • diff --git a/functions/AuthProviders.refreshAuthProvider.html b/functions/AuthProviders.refreshAuthProvider.html index 1167b607..165d85bd 100644 --- a/functions/AuthProviders.refreshAuthProvider.html +++ b/functions/AuthProviders.refreshAuthProvider.html @@ -38,7 +38,7 @@
    clientConfig: Returns Promise<OIDCRefreshTokenProvider>
    +
  • Defined in auth/providers.ts:81
    • diff --git a/functions/AuthProviders.reqSignature.html b/functions/AuthProviders.reqSignature.html index c64545b5..1a81546f 100644 --- a/functions/AuthProviders.reqSignature.html +++ b/functions/AuthProviders.reqSignature.html @@ -41,7 +41,7 @@

    Returns Promise<

    +
  • Defined in auth/auth.ts:61
    • diff --git a/functions/AuthProviders.withHeaders.html b/functions/AuthProviders.withHeaders.html index ce920acc..917e2c0e 100644 --- a/functions/AuthProviders.withHeaders.html +++ b/functions/AuthProviders.withHeaders.html @@ -40,7 +40,7 @@

    Returns

    +
  • Defined in auth/auth.ts:43
    • diff --git a/modules/AuthProviders.html b/modules/AuthProviders.html index 321b11d6..08399000 100644 --- a/modules/AuthProviders.html +++ b/modules/AuthProviders.html @@ -21,7 +21,7 @@

    Namespace AuthProviders

    +
  • Defined in auth/providers.ts:1

    • Index

    diff --git a/types/AuthProviders.HttpMethod.html b/types/AuthProviders.HttpMethod.html index 39a07243..5d519d38 100644 --- a/types/AuthProviders.HttpMethod.html +++ b/types/AuthProviders.HttpMethod.html @@ -18,7 +18,7 @@

    Type alias HttpMethod

    HttpMethod: "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH"
    +
  • Defined in auth/auth.ts:3
    • diff --git a/variables/clientType.html b/variables/clientType.html index 238b910d..84c518e6 100644 --- a/variables/clientType.html +++ b/variables/clientType.html @@ -20,7 +20,7 @@

    Variable clientTypeConst

    +
  • Defined in version.ts:9
    • diff --git a/variables/version.html b/variables/version.html index a4b5ccce..00dd4b6b 100644 --- a/variables/version.html +++ b/variables/version.html @@ -20,7 +20,7 @@

    Variable versionConst

    +
  • Defined in version.ts:4