ExportFormat Property
The format to which the certficate is exported.
Syntax
certmgr.getExportFormat([callback]) certmgr.setExportFormat( exportFormat, [callback])
Default Value
"PFX"
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getExportFormat([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setExportFormat([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
ExportFormat is applicable when ExportCertificate is called and may be used to specify the output format. The applicability of each format depends on whether ExportPrivateKey is set. Some formats are only applicable when exporting to a private key and some values are only applicable when exporting to a public key.
| ExportFormat | Applicability | Description |
| "PFX" or "PKCS12" (default) | Private Keys | A PFX file (PKCS12). |
| "PEM" | Public and Private Keys |
A PEM formatted public certificate (X509/PKCS1/PKCS8), or PEM formatted private key (PKCS1/PKCS8). When ExportPrivateKey is False the exported certificate will be a PEM formatted X509 public certificate if the certificate being exported includes X509 data. If no X509 information is present the public key will be exported in PKCS1 public key format for RSA/DSA keys and PKCS8 public key format for ECDSA/EdDSA keys. When ExportPrivateKey is True the exported certificate will be a PEM formatted PKCS1 private key for RSA/DSA keys and a PEM formatted PKCS8 proviate key for ECDSA/EdDSA keys. Example when ExportPrivateKey is False:
-----BEGIN CERTIFICATE----- MIIBkTCB+6ADAgECAgEBMA0GCSqGSIb3DQEBBQUAMA4xDDAKBgNVBAMTAzEwMDAgFw0wNzAx ... Pg49SpQ+HcUibIpum2O0hmnySH7BPGfXD8Lu -----END CERTIFICATE-----Example when ExportPrivateKey is True: -----BEGIN RSA PRIVATE KEY----- MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry ... 91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw== -----END RSA PRIVATE KEY----- |
| "PKCS1" | Public and Private Keys | A PEM formatted PKCS1 key file.
Example when ExportPrivateKey is False:
-----BEGIN RSA PUBLIC KEY----- MIGJAoGBALAyxV5assz+9v7aHbj93NYN5uGB/1z7kb2Nx4hj02QyRYbcD4htkhK4Qcq2GCsG ... MxW4+pdeN4oEZ6rbMZt01bvMwNRX2GDEyQBhAgMBAAE= -----END RSA PUBLIC KEY-----Example when ExportPrivateKey is True: -----BEGIN RSA PRIVATE KEY----- MIICWwIBAAKBgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3yaZ98bvry ... 91y8ydb3mQ9l1hZudo2sj8tHnvEgph0r7B8hMM6Qaw== -----END RSA PRIVATE KEY----- |
| "PKCS8" | Public and Private Keys | A PEM formatted PKCS8 key file.
Example when ExportPrivateKey is False:
-----BEGIN PUBLIC KEY----- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxdTNtpJQbw90cq6aJEx5vRIBrAiCAB9/F ... 8UdUliXeU8UGYjVcMhGy5oPsVeBXGcPAqF2mjXdBKNnzlSlctOLnYRBS5jwRuNfTQQIDAQAB -----END PUBLIC KEY-----Example when ExportPrivateKey is True: -----BEGIN PRIVATE KEY----- MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAPn9JMdR3tiQ3UnK ... HSvsHyEwzpBr -----END PRIVATE KEY----- |
| "OpenSSH" | Public and Private Keys | An OpenSSH public or private key file.
Example when ExportPrivateKey is False:
ssh-rsa AAAAB3NzaC1y...Example when ExportPrivateKey is True: -----BEGIN OPENSSH PRIVATE KEY----- b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAlwAAAAdzc2gtcnNh ... AwQFBgcICQo= -----END OPENSSH PRIVATE KEY----- |
| "PPK" | Private Keys | A PuTTY private key file.
Example:
PuTTY-User-Key-File-2: ssh-rsa Encryption: none Comment: rsa-key-20180822 Public-Lines: 4 AAAAB3NzaC1yc2EAAAADAQABAAAAgQCmz5j5kWUKxfwiv6J0LQ4wN9ekpeORXVaP ... 8pSSWejQ5Q== Private-Lines: 8 AAAAgH87Sp/YcSw1dKoAZuWb0/2dKkKwMRIYEkS15caRpzAteay6WWX7l1sgBTU7 ... Oa0= Private-MAC: d53e24f44bde8d1d3844a142fbb1fa7c88ea3585 |
| "SSH2PublicKey" | Public Keys | An SSH2 public key.
Example:
---- BEGIN SSH2 PUBLIC KEY ---- AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y ... 6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow== ---- END SSH2 PUBLIC KEY ---- |
| "SSH2PrivateKey" | Private Keys | An SSH2 private key.
Example:
---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ---- AAAAB3NzaC1yc2EAAAADAQABAAAAgQD5/STHUd7YkN1JyoyYnUvCf+Fyx1+ZleBJxvwDcm3y ... 6bVPTODELil1PVWJDlfdwoLZZKY2ACFHzxBqaOlYv1rbd2JIYAuqGca2ow== ---- END SSH2 ENCRYPTED PRIVATE KEY ---- |
| "JWK" | Private and Public Keys | A JSON Web Key (JWK).
Example when ExportPrivateKey is False:
{
"kty": "EC",
"crv": "P-256",
"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q"
}
Example when ExportPrivateKey is True:
{
"kty": "EC",
"crv": "P-256",
"x": "M_P_uqzP43FYW-kXWlpEDlX3nPZUr1QaMllAxUnao7w",
"y": "zRFhp7iCXYIoTgerQ4LjGPTujodlimrwIMk-3enj_1Q",
"d": "eFBtl-uaB9Y4b-CIav5IYX4gGRFBvpBmrMOOQ7L-euI"
}
|
| "XML" | Private and Public Keys | An XML file holding the key or X509 data.
Example when ExportPrivateKey is False:
<X509Data> <X509Certificate>MIIB...D8Lu</X509Certificate> </X509Data>Example when ExportPrivateKey is True: <RSAKeyValue> <Modulus>+f0k...tqM=</Modulus> <Exponent>AQAB</Exponent> <P>/cOnF...tGw==</P> <Q>/DD5...dGQ==</Q> <DP>d75...N0w==</DP> <DQ>Cyv...rKQ==</DQ> <InverseQ>fsB...Qaw==</InverseQ> <D>J7p...YJE=</D> </RSAKeyValue> |
Data Type
String