Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions specs/authorization/authorization.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.KasPublicKeyAlgEnum:
type: string
Expand All @@ -151,6 +154,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SourceType:
type: string
title: SourceType
Expand Down Expand Up @@ -186,6 +192,7 @@ components:
Example Request Get Decisions to answer the question - Do Bob (represented by entity chain ec1)
and Alice (represented by entity chain ec2) have TRANSMIT authorization for
2 resources; resource1 (attr-set-1) defined by attributes foo:bar resource2 (attr-set-2) defined by attribute foo:bar, color:red ?

{
"actions": [
{
Expand Down Expand Up @@ -257,11 +264,13 @@ components:
Example response for a Decision Request - Do Bob (represented by entity chain ec1)
and Alice (represented by entity chain ec2) have TRANSMIT authorization for
2 resources; resource1 (attr-set-1) defined by attributes foo:bar resource2 (attr-set-2) defined by attribute foo:bar, color:red ?

Results:
- bob has permitted authorization to transmit for a resource defined by attr-set-1 attributes and has a watermark obligation
- bob has denied authorization to transmit a for a resource defined by attr-set-2 attributes
- alice has permitted authorization to transmit for a resource defined by attr-set-1 attributes
- alice has denied authorization to transmit a for a resource defined by attr-set-2 attributes

{
"entityChainId": "ec1",
"resourceAttributesId": "attr-set-1",
Expand Down Expand Up @@ -449,7 +458,9 @@ components:
additionalProperties: false
description: |-
Request to get entitlements for one or more entities for an optional attribute scope

Example: Get entitlements for bob and alice (both represented using an email address

{
"entities": [
{
Expand Down Expand Up @@ -480,6 +491,7 @@ components:
additionalProperties: false
description: |-
Example Response for a request of : Get entitlements for bob and alice (both represented using an email address

{
"entitlements": [
{
Expand Down Expand Up @@ -551,6 +563,7 @@ components:
Example Request Get Decisions by Token to answer the question - Do Bob and client1 (represented by token tok1)
and Alice and client2 (represented by token tok2) have TRANSMIT authorization for
2 resources; resource1 (attr-set-1) defined by attributes foo:bar resource2 (attr-set-2) defined by attribute foo:bar, color:red ?

{
"actions": [
{
Expand Down
6 changes: 6 additions & 0 deletions specs/authorization/v2/authorization.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.KasPublicKeyAlgEnum:
type: string
Expand All @@ -186,6 +189,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SourceType:
type: string
title: SourceType
Expand Down
6 changes: 3 additions & 3 deletions specs/kas/kas.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ components:
description: |-
Type of key wrapping used for the data encryption key
Required: Always
Values: 'wrapped' (RSA-wrapped for ZTDF), 'ec-wrapped' (experimental ECDH-wrapped)
Values: 'wrapped' (RSA-wrapped for ZTDF), 'ec-wrapped' (experimental ECDH-wrapped), 'hybrid-wrapped' (experimental X-Wing-wrapped)
url:
type: string
title: kas_url
Expand Down Expand Up @@ -282,7 +282,7 @@ components:
description: |-
Ephemeral public key for ECDH key derivation (ec-wrapped type only)
Required: When key_type="ec-wrapped" (experimental ECDH-based ZTDF)
Omitted: When key_type="wrapped" (RSA-based ZTDF)
Omitted: When key_type="wrapped" or key_type="hybrid-wrapped"
Should be a PEM-encoded PKCS#8 (ASN.1) formatted public key
Used to derive the symmetric key for unwrapping the DEK
title: KeyAccess
Expand Down Expand Up @@ -472,7 +472,7 @@ components:
description: |-
KAS's ephemeral session public key in PEM format
Required: For EC-based operations (key_type="ec-wrapped")
Optional: Empty for RSA-based ZTDF (key_type="wrapped")
Optional: Empty for RSA-based or X-Wing-based ZTDF (key_type="wrapped" or key_type="hybrid-wrapped")
Used by client to perform ECDH key agreement and decrypt the kas_wrapped_key values
schemaVersion:
type: string
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/actions/actions.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -229,6 +232,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SourceType:
type: string
title: SourceType
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/attributes/attributes.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -748,6 +751,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SortDirection:
type: string
title: SortDirection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.KasPublicKeyAlgEnum:
type: string
Expand All @@ -534,6 +537,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.KeyMode:
type: string
title: KeyMode
Expand Down Expand Up @@ -1165,7 +1171,7 @@ components:
Required The algorithm to be used for the key
The key_algorithm must be one of the defined values.:
```
this in [1, 2, 3, 4, 5]
this in [1, 2, 3, 4, 5, 6, 7, 8]
```

$ref: '#/components/schemas/policy.Algorithm'
Expand Down Expand Up @@ -1722,7 +1728,7 @@ components:
Filter keys by algorithm
The key_algorithm must be one of the defined values.:
```
this in [0, 1, 2, 3, 4, 5]
this in [0, 1, 2, 3, 4, 5, 6, 7, 8]
```

$ref: '#/components/schemas/policy.Algorithm'
Expand Down Expand Up @@ -1996,7 +2002,7 @@ components:
Required
The key_algorithm must be one of the defined values.:
```
this in [1, 2, 3, 4, 5]
this in [1, 2, 3, 4, 5, 6, 7, 8]
```

$ref: '#/components/schemas/policy.Algorithm'
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/namespaces/namespaces.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.KasPublicKeyAlgEnum:
type: string
Expand All @@ -364,6 +367,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SortDirection:
type: string
title: SortDirection
Expand Down
7 changes: 7 additions & 0 deletions specs/policy/objects.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -47,6 +50,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.KeyMode:
type: string
title: KeyMode
Expand Down Expand Up @@ -987,6 +993,7 @@ components:
authoritative source such as an IDP (Identity Provider) or User Store.
Examples include such ADFS/LDAP, OKTA, etc. For now, a valid property must
contain both a selector expression & a resulting value.

The external_selector_value is a specifier to select a value from a flattened
external representation of an Entity (such as from idP/LDAP), and the
external_value is the value selected by the external_selector_value on that
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/obligations/obligations.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -579,6 +582,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SortDirection:
type: string
title: SortDirection
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -439,6 +442,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SortDirection:
type: string
title: SortDirection
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/resourcemapping/resource_mapping.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -439,6 +442,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SourceType:
type: string
title: SourceType
Expand Down
7 changes: 7 additions & 0 deletions specs/policy/subjectmapping/subject_mapping.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -475,6 +478,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.SortDirection:
type: string
title: SortDirection
Expand Down Expand Up @@ -1291,6 +1297,7 @@ components:
authoritative source such as an IDP (Identity Provider) or User Store.
Examples include such ADFS/LDAP, OKTA, etc. For now, a valid property must
contain both a selector expression & a resulting value.

The external_selector_value is a specifier to select a value from a flattened
external representation of an Entity (such as from idP/LDAP), and the
external_value is the value selected by the external_selector_value on that
Expand Down
6 changes: 6 additions & 0 deletions specs/policy/unsafe/unsafe.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,9 @@ components:
- ALGORITHM_EC_P256
- ALGORITHM_EC_P384
- ALGORITHM_EC_P521
- ALGORITHM_HPQT_XWING
- ALGORITHM_HPQT_SECP256R1_MLKEM768
- ALGORITHM_HPQT_SECP384R1_MLKEM1024
description: Supported key algorithms.
policy.AttributeRuleTypeEnum:
type: string
Expand All @@ -413,6 +416,9 @@ components:
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP256R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP384R1
- KAS_PUBLIC_KEY_ALG_ENUM_EC_SECP521R1
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_XWING
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP256R1_MLKEM768
- KAS_PUBLIC_KEY_ALG_ENUM_HPQT_SECP384R1_MLKEM1024
policy.KeyMode:
type: string
title: KeyMode
Expand Down