Skip to content

Commit

Permalink
Update api for palmtree.
Browse files Browse the repository at this point in the history
  • Loading branch information
lostlevels committed Sep 6, 2023
1 parent a26830c commit da23dd3
Show file tree
Hide file tree
Showing 9 changed files with 75 additions and 35 deletions.
24 changes: 6 additions & 18 deletions reference/auth/models/assertionsecret.v1.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
title: AssertionSecret
description: Data sent back upon successful app assertion. This will include X.509 certificates.
title: Assertion Secret
description: Data sent back upon successful app assertion.
type: object
properties:
certificates:
description: X.509 certificates to be used for client authentication.
type: array
items:
type: object
properties:
content:
$ref: '../../common/models/base64.v1.yaml'
description: base64 encoded X.509 certificate in DER format.
ttlInDays:
type: integer
type:
type: string
enum:
- CONSTRAINED
- WILDCARD
data:
oneOf:
- $ref: './coastalresponse.v1.yaml'
- $ref: './palmtreeresponse.v1.yaml'
9 changes: 6 additions & 3 deletions reference/auth/models/assertionverify.v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ description: Request body for verifying an assertion.
type: object
properties:
assertion:
$ref: '../../common/models/base64.v1.yaml'
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
description: Base64 encoded data received from Apple App Attest API. User must base64 encode the binary data received from Apple.
clientData:
type: object
Expand All @@ -18,9 +19,11 @@ properties:
minLength: 1
enum:
- Coastal
- PalmTree
partnerData:
description: Actual data to send to partner API.
$ref: './coastaldata.v1.yaml'
oneOf:
- $ref: './coastalrequest.v1.yaml'
- $ref: './palmtreerequest.v1.yaml'
description: Actual data requested by client. Must include the previously requested challenge.
keyId:
$ref: './keyid.v1.yaml'
Expand Down
4 changes: 2 additions & 2 deletions reference/auth/models/attestationverify.v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ description: Request body for verifying an attestation.
type: object
properties:
attestation:
$ref: '../../common/models/base64.v1.yaml'
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
description: Base64 encoded data received from Apple App Attest API. User must base64 encode the binary data received from Apple.
challenge:
type: string
minLength: 1
description: The previously returned attestation challenge.
keyId:
$ref: './keyid.v1.yaml'
description: Base64 encoded key Id received from Apple App Attest API.
required:
- attestation
- challenge
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
title: CoastalData
title: Coastal Request Data
description: Data to send to Coastal's API.
type: object
properties:
rcTypeId:
type: string
minLength: 1
rcInstanceId:
type: string
minLength: 1
Expand All @@ -23,10 +20,7 @@ properties:
type: string
minLength: 1
csr:
$ref: '../../common/models/base64.v1.yaml'
description: Base64 encoded string of the PEM formatted certificate signing request to the partner API.
minLength: 1
rcbMac:
type: string
description: Deprecated field that will be removed in the future but currently required by partner. Value can be any non empty string.
minLength: 1
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
description: Base64 encoded string of the PEM formatted certificate signing request to the partner API.
minLength: 1
21 changes: 21 additions & 0 deletions reference/auth/models/coastalresponse.v1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
title: Coastal Response
description: Data retrieved from Coastal's API.
type: object
properties:
certificates:
description: X.509 certificates to be used for client authentication.
type: array
items:
type: object
properties:
content:
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
description: base64 encoded X.509 certificate in DER format.
ttlInDays:
type: integer
type:
type: string
enum:
- CONSTRAINED
- WILDCARD
3 changes: 2 additions & 1 deletion reference/auth/models/keyid.v1.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
title: Key Id
description: Base64 encoded key identifier received from apple. The Key Id is some shortened data, usually a hash, used to identify the longer actual key.
$ref: '../../common/models/base64.v1.yaml'
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
3 changes: 2 additions & 1 deletion reference/auth/models/newappchallenge.v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ description: Information needed when generating an attestation or assertion chal
type: object
properties:
keyId:
$ref: '../../common/models/base64.v1.yaml'
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
description: Base64 encoded key Id received from Apple App Attest API.
required:
- keyId
8 changes: 8 additions & 0 deletions reference/auth/models/palmtreerequest.v1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: Palm Tree Request Data
description: Data to send to Palm Tree's API.
type: object
properties:
csr:
description: Base64 encoded certificate signing request.
type: string
pattern: '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'
24 changes: 24 additions & 0 deletions reference/auth/models/palmtreeresponse.v1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
title: Palm Tree Response
description: Data retrieved from Palm Tree's API.
type: object
properties:
type:
type: string
enrollment:
type: object
properties:
body:
type: string
description: PEM encoded certificate.
id:
type: string
issuerName:
type: string
serialNumber:
type: string
subjectName:
type: string
status:
type: string
validityPeriod:
type: string

0 comments on commit da23dd3

Please sign in to comment.