%OAuth2.JWKS

Class %OAuth2.JWKS Extends %RegisteredObject [ Deprecated, System = 4 ]

Methods

GetAlg

ClassMethod GetAlg(Alg As %String) As %DynamicObject [ Deprecated, Internal ]

This method is deprecated. Use the GetAlgInfo method in %Net.JSON.JWA instead.

AddRSA

ClassMethod AddRSA(Alg As %String, ByRef LocalPrivate As %String, ByRef LocalPublic As %String) As %Status [ Deprecated ]

This algorithm adds a new RSA private and public key pair to JSON Web Key Sets (JWKS).

Input parameter:

Alg - The algorithm with which the keys are intended for use.
Supported options for signature:
"RS256", RSASSA-PKCS1-V1_5 using SHA-256
"RS384", RSASSA-PKCS1-V1_5 using SHA-384
"RS512", RSASSA-PKCS1-V1_5 using SHA-512
Supported options for key management:
"RSA1_5", Encryption with RSAES-PKCS1-V1_5
"RSA-OAEP", Encryption with RSAES-OAEP

Output parameters:

LocalPrivate - The Local Private JWKS to which the RSA private key will be added. If it does not already exist it will be created.

Local Public - The Local Public JWKS to which the RSA public key will be added. If it does not already exist it will be created.
This method is deprecated. Use the %Net.JSON.JWK and %Net.JSON.JWKS classes to manipulate JWK and JWKS definitions.

AddOct

ClassMethod AddOct(Alg As %String, ClientSecret As %String, ByRef RemotePublic As %String, EncAlg As %String) As %Status [ Deprecated ]

This method adds a new shared symmetric key to a JSON Web Key Set (JWKS).

Alg - The algorithm for which the key is intended for use.
Supported options for signature:
"HS256", HMAC with SHA-256
"HS384", HMAC with SHA-384
"HS512", HMAC with SHA-512
Supported options for key management:
"A128KW", AES Key Wrap with 128-bit key
"A192KW", AES Key Wrap with 192-bit key
"A256KW", AES Key Wrap with 256-bit key
"dir", direct encryption with a shared symmetric key

ClientSecret - Secret shared between a client and a server. This must have sufficient entropy to support the specified algorithm.

Output Parameter:

RemotePublic - The Remote Public JWKS to which the shared symmetric key will be added. If it does not already exist it will be created.
This method is deprecated. Use the %Net.JSON.JWK and %Net.JSON.JWKS classes to manipulate JWK and JWKS definitions.

AddX509

ClassMethod AddX509(Alg As %String, X509 As %SYS.X509Credentials, ByRef LocalPrivate As %String, ByRef Public As %String) As %Status [ Deprecated ]

This method adds the RSA keys contained in a %SYS.X509Credentials object to JSON Web Key Sets (JWKS).

Input parameters:

Alg - The algorithm with which the keys are intended for use.
Supported options for signature:
"RS256", RSASSA-PKCS1-V1_5 using SHA-256
"RS384", RSASSA-PKCS1-V1_5 using SHA-384
"RS512", RSASSA-PKCS1-V1_5 using SHA-512
Supported options for key encryption:
"RSA1_5", Encryption with RSAES-PKCS1-V1_5
"RSA-OAEP", Encryption with RSAES-OAEP

Output parameters:

If the %SYS.X509Credentials object PrivateKey property is set:

LocalPrivate - The Local Private JWKS to which the RSA private key will be added. If it does not already exist it will be created.

Public - The Local Public JWKS to which the RSA public key will be added. If it does not already exist it will be created.

If the %SYS.X509Credentials object PrivateKey property is null:

Public - The Remote Public JWKS to which the RSA public key will be added. If it does not already exist it will be created.
This method is deprecated. Use the %Net.JSON.JWK and %Net.JSON.JWKS classes to manipulate JWK and JWKS definitions.

AddEC

ClassMethod AddEC(Alg As %String, ByRef LocalPrivate As %String, ByRef LocalPublic As %String) As %Status [ Deprecated ]

This algorithm adds a new EC private and public key pair to JSON Web Key Sets (JWKS).

Input parameter:

Alg - The algorithm with which the keys are intended for use.
Supported options for signature:
"ES256", ECDSA using P-256 and SHA-256
"ES384", ECDSA using P-384 and SHA-384
"ES512", ECDSA using P-521 and SHA-512

Output parameters:

LocalPrivate - The Local Private JWKS to which the EC private key will be added. If it does not already exist it will be created.

Local Public - The Local Public JWKS to which the EC public key will be added. If it does not already exist it will be created.
This method is deprecated. Use the %Net.JSON.JWK and %Net.JSON.JWKS classes to manipulate JWK and JWKS definitions.

AddAsymmetric

ClassMethod AddAsymmetric(alg As %String, X509 As %SYS.X509Credentials = "", ByRef private As %String, ByRef public As %String) As %Status [ Private ]