Class SignedDataVerifier

A class providing utility methods for verifying and decoding App Store signed data.

Example Usage:

const verifier = new SignedDataVerifier([appleRoot, appleRoot2], true, Environment.SANDBOX, "com.example")

try {
    const decodedNotification = verifier.verifyAndDecodeNotification("ey...")
    console.log(decodedNotification)
} catch (e) {
    console.error(e)
}

Index

Constructors

constructor

new SignedDataVerifier(
    appleRootCertificates: Buffer<ArrayBufferLike>[],
    enableOnlineChecks: boolean,
    environment: Environment,
    bundleId: string,
    appAppleId?: number,
): SignedDataVerifier
Parameters
- appleRootCertificates: Buffer<ArrayBufferLike>[]
  A list of DER-encoded root certificates
- enableOnlineChecks: boolean
  Whether to enable revocation checking and check expiration using the current date
- environment: Environment
  The App Store environment to target for checks
- bundleId: string
  The app's bundle identifier
- OptionalappAppleId: number
  The app's identifier, omitted in the sandbox environment
Returns SignedDataVerifier
- Defined in jws_verification.ts:70

Properties

`Protected` `Optional`appAppleId

appAppleId?: number

`Protected`bundleId

bundleId: string

`Protected`enableOnlineChecks

enableOnlineChecks: boolean

`Protected`environment

environment: Environment

`Protected`rootCertificates

rootCertificates: X509Certificate[]

`Protected`verifiedPublicKeyCache

verifiedPublicKeyCache: { [index: string]: CacheValue }

Methods

`Protected`checkOCSPStatus

checkOCSPStatus(cert: X509Certificate, issuer: X509Certificate): Promise<void>
Parameters
- cert: X509Certificate
- issuer: X509Certificate
Returns Promise<void>
- Defined in jws_verification.ts:300

verifyAndDecodeAppTransaction

verifyAndDecodeAppTransaction(
signedAppTransaction: string,
): Promise<AppTransaction>
Verifies and decodes a signed AppTransaction See AppTransaction
Parameters
- signedAppTransaction: string
  The signed AppTransaction
Returns Promise<AppTransaction>
The decoded AppTransaction after validation

Throws
VerificationException Thrown if the data could not be verified
- Defined in jws_verification.ts:169

verifyAndDecodeNotification

verifyAndDecodeNotification(
signedPayload: string,
): Promise<ResponseBodyV2DecodedPayload>
Verifies and decodes an App Store Server Notification signedPayload See signedPayload
Parameters
- signedPayload: string
  The payload received by your server
Returns Promise<ResponseBodyV2DecodedPayload>
The decoded payload after verification

Throws
VerificationException Thrown if the data could not be verified
- Defined in jws_verification.ts:126

verifyAndDecodeRealtimeRequest

verifyAndDecodeRealtimeRequest(
signedPayload: string,
): Promise<DecodedRealtimeRequestBody>
Verifies and decodes a Retention Messaging API signedPayload See signedPayload
Parameters
- signedPayload: string
  The payload received by your server
Returns Promise<DecodedRealtimeRequestBody>
The decoded payload after verification

Throws
VerificationException Thrown if the data could not be verified
- Defined in jws_verification.ts:189

verifyAndDecodeRenewalInfo

verifyAndDecodeRenewalInfo(
signedRenewalInfo: string,
): Promise<JWSRenewalInfoDecodedPayload>
Verifies and decodes a signedRenewalInfo obtained from the App Store Server API, an App Store Server Notification, or from a device See JWSRenewalInfo
Parameters
- signedRenewalInfo: string
  The signedRenewalInfo field
Returns Promise<JWSRenewalInfoDecodedPayload>
The decoded renewal info after verification

Throws
VerificationException Thrown if the data could not be verified
- Defined in jws_verification.ts:109

verifyAndDecodeTransaction

verifyAndDecodeTransaction(
signedTransactionInfo: string,
): Promise<JWSTransactionDecodedPayload>
Verifies and decodes a signedTransaction obtained from the App Store Server API, an App Store Server Notification, or from a device See JWSTransaction
Parameters
- signedTransactionInfo: string
Returns Promise<JWSTransactionDecodedPayload>
The decoded transaction info after verification

Throws
VerificationException Thrown if the data could not be verified
- Defined in jws_verification.ts:90

`Protected`verifyCertificateChain

verifyCertificateChain(
    trustedRoots: X509Certificate[],
    leaf: X509Certificate,
    intermediate: X509Certificate,
    effectiveDate: Date,
): Promise<KeyObject>
Parameters
- trustedRoots: X509Certificate[]
- leaf: X509Certificate
- intermediate: X509Certificate
- effectiveDate: Date
Returns Promise<KeyObject>
- Defined in jws_verification.ts:246

`Protected`verifyCertificateChainWithoutCaching

verifyCertificateChainWithoutCaching(
    trustedRoots: X509Certificate[],
    leaf: X509Certificate,
    intermediate: X509Certificate,
    effectiveDate: Date,
): Promise<KeyObject>
Parameters
- trustedRoots: X509Certificate[]
- leaf: X509Certificate
- intermediate: X509Certificate
- effectiveDate: Date
Returns Promise<KeyObject>
- Defined in jws_verification.ts:271

`Protected`verifyJWT

verifyJWT<T>(
    jwt: string,
    validator: Validator<T>,
    signedDateExtractor: (decodedJWT: T) => Date,
): Promise<T>
Type Parameters
- T
Parameters
- jwt: string
- validator: Validator<T>
- signedDateExtractor: (decodedJWT: T) => Date
Returns Promise<T>
- Defined in jws_verification.ts:200

`Protected`verifyNotification

verifyNotification(
    bundleId?: string,
    appAppleId?: number,
    environment?: string,
): void
Parameters
- OptionalbundleId: string
- OptionalappAppleId: number
- Optionalenvironment: string
Returns void
- Defined in jws_verification.ts:152

Class SignedDataVerifier

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SignedDataVerifier

Properties

Protected OptionalappAppleId

ProtectedbundleId

ProtectedenableOnlineChecks

Protectedenvironment

ProtectedrootCertificates

ProtectedverifiedPublicKeyCache

Methods

ProtectedcheckOCSPStatus

Parameters

Returns Promise<void>

verifyAndDecodeAppTransaction

Parameters

Returns Promise<AppTransaction>

Throws

verifyAndDecodeNotification

Parameters

Returns Promise<ResponseBodyV2DecodedPayload>

Throws

verifyAndDecodeRealtimeRequest

Parameters

Returns Promise<DecodedRealtimeRequestBody>

Throws

verifyAndDecodeRenewalInfo

Parameters

Returns Promise<JWSRenewalInfoDecodedPayload>

Throws

verifyAndDecodeTransaction

Parameters

Returns Promise<JWSTransactionDecodedPayload>

Throws

ProtectedverifyCertificateChain

Parameters

Returns Promise<KeyObject>

ProtectedverifyCertificateChainWithoutCaching

Parameters

Returns Promise<KeyObject>

ProtectedverifyJWT

Type Parameters

Parameters

Returns Promise<T>

ProtectedverifyNotification

Parameters

Returns void

Settings

On This Page

`Protected` `Optional`appAppleId

`Protected`bundleId

`Protected`enableOnlineChecks

`Protected`environment

`Protected`rootCertificates

`Protected`verifiedPublicKeyCache

`Protected`checkOCSPStatus

`Protected`verifyCertificateChain

`Protected`verifyCertificateChainWithoutCaching

`Protected`verifyJWT

`Protected`verifyNotification