com.google.api.client.auth.security

Class PrivateKeys

java.lang.Object

com.google.api.client.auth.security.PrivateKeys

public class PrivateKeys
extends Object

Utility methods for private keys.

Since:

1.7

Author:

Yaniv Inbar

Method Summary

Methods

Modifier and Type	Method and Description
static PrivateKey	loadFromKeyStore(InputStream keyStream, String storePass, String alias, String keyPass) Retrieves the private key from the specified key store stream using default key store.
static PrivateKey	loadFromKeyStore(KeyStore keyStore, InputStream keyStream, String storePass, String alias, String keyPass) Retrieves the private key from the specified key store stream and specified key store.
static PrivateKey	loadFromP12File(File p12File, String storePass, String alias, String keyPass) Reads a PKCS#12 format private key from a given file.
static PrivateKey	loadFromPk8File(File file) Deprecated. (scheduled to be removed in 1.14) Use loadFromPkcs8PemFile(java.io.File) instead. Note that the file formatting requirements for loadFromPkcs8PemFile(java.io.File) are stricter than this method's requirements.
static PrivateKey	loadFromPkcs8PemFile(File pemFile) Reads a PEM formatted PKCS8 encoded private key from a given file.
static byte[]	readFromPemFormattedFile(File file) Reads a PEM formatted private key from a given file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadFromKeyStore

public static PrivateKey loadFromKeyStore(InputStream keyStream,
                          String storePass,
                          String alias,
                          String keyPass)
                                   throws IOException,
                                          GeneralSecurityException

Retrieves the private key from the specified key store stream using default key store.

Parameters:

keyStream - input stream to the key store file (closed at the end of this method in a finally block)

storePass - password protecting the key store file

alias - alias under which the private key is stored

keyPass - password protecting the private key

Returns:

the private key from the specified key store

Throws:

IOException

GeneralSecurityException

loadFromKeyStore

public static PrivateKey loadFromKeyStore(KeyStore keyStore,
                          InputStream keyStream,
                          String storePass,
                          String alias,
                          String keyPass)
                                   throws IOException,
                                          GeneralSecurityException

Retrieves the private key from the specified key store stream and specified key store.

Parameters:

keyStore - key store

keyStream - input stream to the key store file (closed at the end of this method in a finally block)

storePass - password protecting the key store file

alias - alias under which the private key is stored

keyPass - password protecting the private key

Returns:

the private key from the specified key store

Throws:

IOException

GeneralSecurityException

loadFromPk8File

@Deprecated
public static PrivateKey loadFromPk8File(File file)
                                  throws IOException,
                                         GeneralSecurityException

Deprecated. (scheduled to be removed in 1.14) Use loadFromPkcs8PemFile(java.io.File) instead. Note that the file formatting requirements for loadFromPkcs8PemFile(java.io.File) are stricter than this method's requirements.

Reads a PKCS#8 format private key from a given file.

Throws:

IOException

GeneralSecurityException

readFromPemFormattedFile

public static byte[] readFromPemFormattedFile(File file)
                                       throws IOException,
                                              GeneralSecurityException

Reads a PEM formatted private key from a given file.

This supports any file if and only if it contains a DER and Base64 encoded key, and the contents are enclosed by the following:

-----BEGIN PRIVATE KEY-----
-----END PRIVATE KEY-----

The file may contain additional content outside of the BEGIN and END tags, but it will be ignored. This method does not support additional content such as headers inside the BEGIN and END tags. If the file contains multiple BEGIN and END tags, only the content inside the first pair will be read.

Throws:

IOException

GeneralSecurityException

Since:

1.13

loadFromPkcs8PemFile

public static PrivateKey loadFromPkcs8PemFile(File pemFile)
                                       throws IOException,
                                              GeneralSecurityException

Reads a PEM formatted PKCS8 encoded private key from a given file.

This method uses readFromPemFormattedFile(java.io.File), and the file formatting requirements from that method apply.

Throws:

IOException

GeneralSecurityException

Since:

1.13

loadFromP12File

public static PrivateKey loadFromP12File(File p12File,
                         String storePass,
                         String alias,
                         String keyPass)
                                  throws GeneralSecurityException,
                                         IOException

Reads a PKCS#12 format private key from a given file.

Parameters:

p12File - p12 file

storePass - password protecting the key store file

alias - alias under which the private key is stored

keyPass - password protecting the private key

Returns:

loaded private key

Throws:

GeneralSecurityException

IOException