• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Converting a PEM String into an Asymmetric Key Pair (ArkTS)
2
3<!--Kit: Crypto Architecture Kit-->
4<!--Subsystem: Security-->
5<!--Owner: @zxz--3-->
6<!--Designer: @lanming-->
7<!--Tester: @PAFT-->
8<!--Adviser: @zengyawen-->
9
10This topic walks you through on how to convert a string in PEM format into an RSA asymmetric key pair (**KeyPair**).
11
12> **NOTE**
13>
14> The **convertPemKey** operation must comply with the following requirements:
15>
16> - The public key must comply with X.509 specifications, PKCS\#1 specifications, and PEM encoding format.
17>
18> - The private key must comply with the PKCS\#8, PKCS\#1 specifications, and the PEM encoding format.
19>
20> - Currently, only RSA asymmetric keys can be converted.
21
22## Converting a String in PEM Format into an RSA Key Pair
23
24For details about the algorithm specifications, see [RSA](crypto-asym-key-generation-conversion-spec.md#rsa).
25
261. Call [cryptoFramework.createAsyKeyGenerator](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreateasykeygenerator) with the string parameter **'RSA1024'** to create an asymmetric key generator (**AsyKeyGenerator**) object for a 1024-bit RSA key with two primes.
27
28   The default number of primes for creating an RSA asymmetric key is **2**. The **PRIMES_2** parameter is omitted in the string parameter here.
29
302. Call [AsyKeyGenerator.convertPemKey](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#convertpemkey12) to convert the binary data into an asymmetric key pair (**KeyPair**).
313. Call [AsyKeyGenerator.getEncodedPem](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getencodedpem12) to convert the public key in the asymmetric key object into the PKCS #1 or X509 format and the private key into the PKCS #1 or PKCS #8 format.
32
33- Example: Convert a string in PEM format into an RSA key pair (using promise-based APIs).
34
35  ```ts
36  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
37
38  let priKeyPkcs1Str1024: string  =
39    "-----BEGIN RSA PRIVATE KEY-----\n"
40    + "MIICXQIBAAKBgQCwIN3mr21+N96ToxnVnaS+xyK9cNRAHiHGgrbjHw6RAj3V+l+W\n"
41    + "Y68IhIe3DudVlzE9oMjeOQwkMkq//HCxNlIlFR6O6pa0mrXSwPRE7YKG97CeKk2g\n"
42    + "YOS8YEh8toAvm7xKbiLkXuuMlxrjP2j/mb5iI/UASFSPZiQ/IyxDr0AQaQIDAQAB\n"
43    + "AoGAEvBFzBNa+7J4PXnRQlYEK/tvsd0bBZX33ceacMubHl6WVZbphltLq+fMTBPP\n"
44    + "LjXmtpC+aJ7Lvmyl+wTi/TsxE9vxW5JnbuRT48rnZ/Xwq0eozDeEeIBRrpsr7Rvr\n"
45    + "7ctrgzr4m4yMHq9aDgpxj8IR7oHkfwnmWr0wM3FuiVlj650CQQDineeNZ1hUTkj4\n"
46    + "D3O+iCi3mxEVEeJrpqrmSFolRMb+iozrIRKuJlgcOs+Gqi2fHfOTTL7LkpYe8SVg\n"
47    + "e3JxUdVLAkEAxvcZXk+byMFoetrnlcMR13VHUpoVeoV9qkv6CAWLlbMdgf7uKmgp\n"
48    + "a1Yp3QPDNQQqkPvrqtfR19JWZ4uy1qREmwJALTU3BjyBoH/liqb6fh4HkWk75Som\n"
49    + "MzeSjFIOubSYxhq5tgZpBZjcpvUMhV7Zrw54kwASZ+YcUJvmyvKViAm9NQJBAKF7\n"
50    + "DyXSKrem8Ws0m1ybM7HQx5As6l3EVhePDmDQT1eyRbKp+xaD74nkJpnwYdB3jyyY\n"
51    + "qc7A1tj5J5NmeEFolR0CQQCn76Xp8HCjGgLHw9vg7YyIL28y/XyfFyaZAzzK+Yia\n"
52    + "akNwQ6NeGtXSsuGCcyyfpacHp9xy8qXQNKSkw03/5vDO\n"
53    + "-----END RSA PRIVATE KEY-----\n";
54  let publicPkcs1Str1024: string  =
55    "-----BEGIN RSA PUBLIC KEY-----\n"
56    + "MIGJAoGBALAg3eavbX433pOjGdWdpL7HIr1w1EAeIcaCtuMfDpECPdX6X5ZjrwiE\n"
57    + "h7cO51WXMT2gyN45DCQySr/8cLE2UiUVHo7qlrSatdLA9ETtgob3sJ4qTaBg5Lxg\n"
58    + "SHy2gC+bvEpuIuRe64yXGuM/aP+ZvmIj9QBIVI9mJD8jLEOvQBBpAgMBAAE=\n"
59    + "-----END RSA PUBLIC KEY-----\n";
60  async function TestPkcs1ToPkcs8ByPromise() {
61    let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator('RSA1024');
62    let keyPair = await asyKeyGenerator.convertPemKey(publicPkcs1Str1024, priKeyPkcs1Str1024);
63    let priPemKey = keyPair.priKey;
64    let pubPemKey = keyPair.pubKey;
65    let priString = priPemKey.getEncodedPem('PKCS8');
66    let pubString = pubPemKey.getEncodedPem('X509');
67    console.info("[promise]TestPkcs1ToPkcs8ByPromise priString output is " + priString);
68    console.info("[promise]TestPkcs1ToPkcs8ByPromise pubString output is " + pubString);
69  }
70  ```
71
72- Example: Convert a string in PEM format into an RSA key pair (using the synchronous API [convertPemKeySync](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#convertpemkeysync12)).
73
74  ```ts
75  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
76
77  let priKeyPkcs1Str1024: string  =
78    "-----BEGIN RSA PRIVATE KEY-----\n"
79    + "MIICXQIBAAKBgQCwIN3mr21+N96ToxnVnaS+xyK9cNRAHiHGgrbjHw6RAj3V+l+W\n"
80    + "Y68IhIe3DudVlzE9oMjeOQwkMkq//HCxNlIlFR6O6pa0mrXSwPRE7YKG97CeKk2g\n"
81    + "YOS8YEh8toAvm7xKbiLkXuuMlxrjP2j/mb5iI/UASFSPZiQ/IyxDr0AQaQIDAQAB\n"
82    + "AoGAEvBFzBNa+7J4PXnRQlYEK/tvsd0bBZX33ceacMubHl6WVZbphltLq+fMTBPP\n"
83    + "LjXmtpC+aJ7Lvmyl+wTi/TsxE9vxW5JnbuRT48rnZ/Xwq0eozDeEeIBRrpsr7Rvr\n"
84    + "7ctrgzr4m4yMHq9aDgpxj8IR7oHkfwnmWr0wM3FuiVlj650CQQDineeNZ1hUTkj4\n"
85    + "D3O+iCi3mxEVEeJrpqrmSFolRMb+iozrIRKuJlgcOs+Gqi2fHfOTTL7LkpYe8SVg\n"
86    + "e3JxUdVLAkEAxvcZXk+byMFoetrnlcMR13VHUpoVeoV9qkv6CAWLlbMdgf7uKmgp\n"
87    + "a1Yp3QPDNQQqkPvrqtfR19JWZ4uy1qREmwJALTU3BjyBoH/liqb6fh4HkWk75Som\n"
88    + "MzeSjFIOubSYxhq5tgZpBZjcpvUMhV7Zrw54kwASZ+YcUJvmyvKViAm9NQJBAKF7\n"
89    + "DyXSKrem8Ws0m1ybM7HQx5As6l3EVhePDmDQT1eyRbKp+xaD74nkJpnwYdB3jyyY\n"
90    + "qc7A1tj5J5NmeEFolR0CQQCn76Xp8HCjGgLHw9vg7YyIL28y/XyfFyaZAzzK+Yia\n"
91    + "akNwQ6NeGtXSsuGCcyyfpacHp9xy8qXQNKSkw03/5vDO\n"
92    + "-----END RSA PRIVATE KEY-----\n";
93  let publicPkcs1Str1024: string  =
94    "-----BEGIN RSA PUBLIC KEY-----\n"
95    + "MIGJAoGBALAg3eavbX433pOjGdWdpL7HIr1w1EAeIcaCtuMfDpECPdX6X5ZjrwiE\n"
96    + "h7cO51WXMT2gyN45DCQySr/8cLE2UiUVHo7qlrSatdLA9ETtgob3sJ4qTaBg5Lxg\n"
97    + "SHy2gC+bvEpuIuRe64yXGuM/aP+ZvmIj9QBIVI9mJD8jLEOvQBBpAgMBAAE=\n"
98    + "-----END RSA PUBLIC KEY-----\n";
99  function TestPkcs1ToPkcs8BySync() {
100    let asyKeyGenerator = cryptoFramework.createAsyKeyGenerator('RSA1024');
101    try {
102      let keyPairData = asyKeyGenerator.convertPemKeySync(publicPkcs1Str1024, priKeyPkcs1Str1024);
103      if (keyPairData !== null) {
104        console.info('[Sync]: convert pem key pair success');
105      } else {
106        console.error("[Sync]: convert pem key pair result fail!");
107      }
108      let priPemKey = keyPairData.priKey;
109      let pubPemKey = keyPairData.pubKey;
110      let priString = priPemKey.getEncodedPem('PKCS8');
111      let pubString = pubPemKey.getEncodedPem('X509');
112      console.info("[Sync]TestPkcs1ToPkcs8BySync priString output is " + priString);
113      console.info("[Sync]TestPkcs1ToPkcs8BySync pubString output is " + pubString);
114    } catch (e) {
115      console.error(`Sync error, ${e.code}, ${e.message}`);
116    }
117  }
118  ```
119