Skip to main content

%Wallet.AsymmetricKey

abstract persistent class %Wallet.AsymmetricKey extends %Wallet.Secret

SQL Table Name: %Wallet.AsymmetricKey

This abstract %Wallet.Secret type defines the interface for managing asymmetric public / private key pairs.

See the subclass %Wallet.RSA for details.

Property Inventory

Method Inventory

Properties

property Certificate as %String) [ Transient ];
Input only. The PEM encoded certificate.
Property methods: CertificateDisplayToLogical(), CertificateGet(), CertificateIsValid(), CertificateLogicalToDisplay(), CertificateLogicalToOdbc(), CertificateNormalize(), CertificateSet()
property CertificateFile as %String) [ Transient ];
Input only. The name of a file containing the PEM encoded certificate.
Property methods: CertificateFileDisplayToLogical(), CertificateFileGet(), CertificateFileIsValid(), CertificateFileLogicalToDisplay(), CertificateFileLogicalToOdbc(), CertificateFileNormalize(), CertificateFileSet()
property HasCertificate as %Boolean;
True if the secret contains a certificate. If false, the secret must contain a public key.
Property methods: HasCertificateDisplayToLogical(), HasCertificateGet(), HasCertificateGetStored(), HasCertificateIsValid(), HasCertificateLogicalToDisplay(), HasCertificateLogicalToXSD(), HasCertificateNormalize(), HasCertificateSet(), HasCertificateXSDToLogical()
property HasPrivateKey as %Boolean;
True if the secret contains the private key. This is needed for signing or encryption operations.
Property methods: HasPrivateKeyDisplayToLogical(), HasPrivateKeyGet(), HasPrivateKeyGetStored(), HasPrivateKeyIsValid(), HasPrivateKeyLogicalToDisplay(), HasPrivateKeyLogicalToXSD(), HasPrivateKeyNormalize(), HasPrivateKeySet(), HasPrivateKeyXSDToLogical()
property Password as %String) [ Transient ];
Input only. If the private key contained in either PrivateKey or PrivateKeyFile is encrypted, this is the password to decrypt it.
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property PrivateKey as %String) [ Transient ];
Input only. The PEM encoded private key. This may be encrypted with Password.
Property methods: PrivateKeyDisplayToLogical(), PrivateKeyGet(), PrivateKeyIsValid(), PrivateKeyLogicalToDisplay(), PrivateKeyLogicalToOdbc(), PrivateKeyNormalize(), PrivateKeySet()
property PrivateKeyFile as %String) [ Transient ];
Input only. The name of a file containing The PEM encoded private key. This may be encrypted with Password.
Property methods: PrivateKeyFileDisplayToLogical(), PrivateKeyFileGet(), PrivateKeyFileIsValid(), PrivateKeyFileLogicalToDisplay(), PrivateKeyFileLogicalToOdbc(), PrivateKeyFileNormalize(), PrivateKeyFileSet()
property PublicKey as %String) [ Transient ];
Input only. The PEM encoded public key.
Property methods: PublicKeyDisplayToLogical(), PublicKeyGet(), PublicKeyIsValid(), PublicKeyLogicalToDisplay(), PublicKeyLogicalToOdbc(), PublicKeyNormalize(), PublicKeySet()
property PublicKeyFile as %String) [ Transient ];
Input only. The name of a file containing The PEM encoded public key.
Property methods: PublicKeyFileDisplayToLogical(), PublicKeyFileGet(), PublicKeyFileIsValid(), PublicKeyFileLogicalToDisplay(), PublicKeyFileLogicalToOdbc(), PublicKeyFileNormalize(), PublicKeyFileSet()

Methods

classmethod GetPublic(name As %String) as %DynamicObject
Returns the certificate (or public key) stored in this secret, and public metadata. The returned values are:
  • PublicKey: The PEM encoded public key or X.509 certificate stored by this secret.
  • HasCertificate: Whether the secret stores a X.509 certificate or a plain public key.
  • HasPrivateKey: Whether the secret contains the matching private key.

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%Wallet.Secret)

^|$$$SecurityMapWallet|WALLET("SecretD")(ID)
=
%%CLASSNAME
Storage
Collection
Version

Storage Model: Storage (%Wallet.AsymmetricKey)

^|$$$SecurityMapWallet|WALLET("SecretD")(ID,"AsymmetricKey")
=
HasCertificate
HasPrivateKey

Subclasses

FeedbackOpens in a new tab