| 1 | <?xml version='1.0' encoding='UTF-8'?>
|
|---|
| 2 | <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 3 | <topic xml:lang="en-us" id="cloud-create-api-keypair">
|
|---|
| 4 | <title>Creating an API Signing Key Pair</title>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 7 | <p>To use the cloud integration features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you must generate an API signing key pair that is used for API requests to <ph conkeyref="vbox-conkeyref-phrases/oci"/>.</p>
|
|---|
| 8 | <p>Your API requests are signed with your private key, and <ph conkeyref="vbox-conkeyref-phrases/oci"/> uses the public key to verify the authenticity of the request. You must upload the public key to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> Console.</p>
|
|---|
| 9 | <note>
|
|---|
| 10 | <p> This key pair is not the same SSH key that you use to access compute instances on <ph conkeyref="vbox-conkeyref-phrases/oci"/>.</p>
|
|---|
| 11 | </note>
|
|---|
| 12 | <ol>
|
|---|
| 13 | <li>
|
|---|
| 14 | <p>(Optional) Create a <filepath>.oci</filepath> directory to store the key pair.</p>
|
|---|
| 15 | <pre xml:space="preserve">$ mkdir ~/.oci</pre>
|
|---|
| 16 | <p>The key pair is usually installed in the <filepath>.oci</filepath> folder in your home directory. For example, <filepath>~/.oci</filepath> on a Linux system.</p>
|
|---|
| 17 | </li>
|
|---|
| 18 | <li>
|
|---|
| 19 | <p>Generate the private key. </p>
|
|---|
| 20 | <p>Use the <codeph>openssl</codeph> command.</p>
|
|---|
| 21 | <ul>
|
|---|
| 22 | <li>
|
|---|
| 23 | <p> To generate a private key with a passphrase (prompt for passphrase):</p>
|
|---|
| 24 | <pre xml:space="preserve">$ openssl genrsa -out ~/.oci/oci_api_key.pem -aes256 2048 </pre>
|
|---|
| 25 | </li>
|
|---|
| 26 | <li>
|
|---|
| 27 | <p> To generate a private key with a passphrase entered on the command line as an argument:</p>
|
|---|
| 28 | <pre xml:space="preserve">$ openssl genrsa -aes256 -passout pass:user_passphrase -out ~/.oci/oci_api_key.pem 2048</pre>
|
|---|
| 29 | </li>
|
|---|
| 30 | <li>
|
|---|
| 31 | <p> To generate a private key without a passphrase:</p>
|
|---|
| 32 | <pre xml:space="preserve">$ openssl genrsa -out ~/.oci/oci_api_key.pem 2048</pre>
|
|---|
| 33 | </li>
|
|---|
| 34 | </ul>
|
|---|
| 35 | </li>
|
|---|
| 36 | <li>
|
|---|
| 37 | <p>Change permissions for the private key.</p>
|
|---|
| 38 | <pre xml:space="preserve">$ chmod 600 ~/.oci/oci_api_key.pem</pre>
|
|---|
| 39 | <p>Generate the public key.</p>
|
|---|
| 40 | <pre xml:space="preserve">$ openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem</pre>
|
|---|
| 41 | <p>Enter the passphrase when prompted, if you set one.</p>
|
|---|
| 42 | </li>
|
|---|
| 43 | </ol>
|
|---|
| 44 | </body>
|
|---|
| 45 |
|
|---|
| 46 | </topic>
|
|---|
