Snowflake KeyPair Partition Connector

​

Intro

​

Prerequisites

• The full name of your account (provided by Snowflake). This is the portion of your Snowflake URL immediately following https://. Note that your full account name may include additional segments that identify the region and cloud platform where your account is hosted. For US West Region account_name and All other regions account_name.region_id. The following table provides account name examples by cloud platform/region. For each row, it assumes your account name is “xy12345.”

• The username used to connect to your Snowflake host.
• The private key.
• The passphrase. If you create an encrypted private key, then OpenSSL prompts for a passphrase used to encrypt the private key file.
• Your role name.

​

Configuring the public/private key pair

1. From the command line in a terminal window, generate a private key. You can generate either an encrypted version of the private key or an unencrypted version of the private key.
   • To generate an unencrypted version, use the following command: $ openssl genrsa -out rsa_key.pem 2048
   • To generate an encrypted version, use the following command: $ openssl genrsa 2048 | openssl pkcs8 -topk8 -inform PEM -out rsa_key.p8 It is typically safer to generate an encrypted version. If you use the second command to encrypt the private key, then OpenSSL prompts for a passphrase used to encrypt the private key file. We recommend using a strong passphrase to protect the private key. Record this passphrase in a secure location. You will input it when connecting to Snowflake. Note that the passphrase is only used for protecting the private key and will never be sent to Snowflake. The following is a sample PEM private key:
     Copy

     Ask AI

     -----BEGIN ENCRYPTED PRIVATE KEY-----
     MIIE6TAbBgkqhkiG9w0BBQMwDgQILYPyCppzOwECAggABIIEyLiGSpeeGSe3xHP1
     wHLjfCYycUPennlX2bd8yX8xOxGSGfvB+99+PmSlex0FmY9ov1J8H1H9Y3lMWXbL
     ...
     -----END ENCRYPTED PRIVATE KEY-----
     
2. From the command line, generate the public key by referencing the private key. Assuming the private key is encrypted and contained in the file named “rsa_key.p8”, use the following command: $ openssl rsa -in rsa_key.p8 -pubout -out rsa_key.pub The following is a sample PEM public key:
   Copy

   Ask AI

   -----BEGIN PUBLIC KEY-----
   MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAy+Fw2qv4Roud3l6tjPH4
   zxybHjmZ5rhtCz9jppCV8UTWvEXxa88IGRIHbJ/PwKW/mR8LXdfI7l/9vCMXX4mk
   ...
   -----END PUBLIC KEY-----
   
3. Copy the public and private key files to a local directory for storage. Record the path to the files. Note that the private key is stored using the PKCS#8 (Public Key Cryptography Standards) format and is encrypted using the passphrase you specified in the previous step; however, the file should still be protected from unauthorized access using the file permission mechanism provided by your operating system. It is your responsibility to secure the file when it is not being used.
4. Assign the public key to the Snowflake user using ALTER USER. For example: alter user jsmith set rsa_public_key='MIIBIjANBgkqh...';
   Notes:

   • Only security administrators (i.e. users with the SECURITYADMIN role) or higher can alter a user.
   • Exclude the public key header and footer in the SQL statement.
5. Verify the user’s public key fingerprint using DESCRIBE USER:

   Property	Value	Default	Description
   Name	JSMITH	null	Name
   RSA_PUBLIC_KEY_FP	SHA256:nvnONUsfiuycCLMXIEWG4eTp4FjhVUZQUQbNpbSHXiA=	null	Fingerprint of user’s RSA public key.
   RSA_PUBLIC_KEY_2_FP	null	null	Fingerprint of user’s second RSA public key.

   Note: For more information about the RSA_PUBLIC_KEY_2_FP property, see Key Rotation.
6. Modify and execute the sample code, below. The code decrypts the private key file and passes it to the Snowflake driver to create a connection:
   • Update the security parameters:
     • <path> specifies the local path to the private key file you created.
   • Update the session parameters:
     • <user> specifies your Snowflake login name.
     • <account> specifies the name of your account (provided by Snowflake).
   • The sample code is as follows:
     Copy

     Ask AI

     import java.util.Properties;
     import java.sql.Connection;
     import java.sql.Statement;
     import java.sql.ResultSet;
     import java.sql.DriverManager;
     import java.io.File;
     import java.io.FileInputStream;
     import java.io.DataInputStream;
     import java.util.Base64;
     import java.security.spec.PKCS8EncodedKeySpec;
     import java.security.KeyFactory;
     import java.security.PrivateKey;
     import javax.crypto.EncryptedPrivateKeyInfo;
     import javax.crypto.SecretKeyFactory;
     import javax.crypto.spec.PBEKeySpec;
     
     public class TestJdbc
     {
        public static void main(String[] args)
           throws Exception
        {
           File f = new File("<path>/rsa_key.p8");
           FileInputStream fis = new FileInputStream(f);
           DataInputStream dis = new DataInputStream(fis);
           byte[] keyBytes = new byte[(int) f.length()];
           dis.readFully(keyBytes);
           dis.close();
     
           String encrypted = new String(keyBytes);
           String passphrase = System.getenv("PRIVATE_KEY_PASSPHRASE");
           encrypted = encrypted.replace("-----BEGIN ENCRYPTED PRIVATE KEY-----", "");
           encrypted = encrypted.replace("-----END ENCRYPTED PRIVATE KEY-----", "");
           EncryptedPrivateKeyInfo pkInfo = new EncryptedPrivateKeyInfo(Base64.getMimeDecoder().decode(encrypted));
           PBEKeySpec keySpec = new PBEKeySpec(passphrase.toCharArray());
           SecretKeyFactory pbeKeyFactory = SecretKeyFactory.getInstance(pkInfo.getAlgName());
           PKCS8EncodedKeySpec encodedKeySpec = pkInfo.getKeySpec(pbeKeyFactory.generateSecret(keySpec));
           KeyFactory keyFactory = KeyFactory.getInstance("RSA");
           PrivateKey encryptedPrivateKey = keyFactory.generatePrivate(encodedKeySpec);
     
           String url = "jdbc:snowflake://<account>.snowflakecomputing.com";
           Properties prop = new Properties();
           prop.put("user", "<user>");
           prop.put("account", "<account>");
           prop.put("privateKey", encryptedPrivateKey);
     
           Connection conn = DriverManager.getConnection(url, prop);
           Statement stat = conn.createStatement();
           ResultSet res = stat.executeQuery("select 1");
           res.next();
           System.out.println(res.getString(1));
           conn.close();
        }
     }
     

​

Key Rotation

1. Complete the steps in Using Key Pair Authentication to…
   • Generate a new private and public key set.
   • Assign the public key to the user. Set the public key value to either RSA_PUBLIC_KEY or RSA_PUBLIC_KEY_2 (whichever key value is not currently in use). For example: alter user jsmith set rsa_public_key_2='JERUEHtcve...';
2. Update the code to connect to Snowflake. Specify the new private key. Snowflake verifies the correct active public key for authentication based on the private key submitted with your connection information.
3. Remove the old public key from the user profile. For example: alter user jsmith unset rsa_public_key;

​

Connecting to Your Snowflake Account

​

Credentials Pane

​

Details Pane

​

Other Panes

​

FAQs

​

Troubleshooting

• Make sure your authentication remains valid.
• Review the configuration to make sure that all required items have been selected.
• Review the Connector history for error messages.
• In rare cases, you may be requesting too much information and reaching API limitations or timeouts. If this is the case, you can review the history of the Connector run to see the error message and duration. If this is the case, you can reduce the number of accounts that are being pulled, choose a smaller number of metrics for the report that you are pulling, or reduce the timeframe that you are trying to pull.