com.turo.pushy.apns.auth

Class ApnsSigningKey

java.lang.Object

com.turo.pushy.apns.auth.ApnsKey

com.turo.pushy.apns.auth.ApnsSigningKey

All Implemented Interfaces:

Serializable, ECKey, ECPrivateKey, Key, PrivateKey, Destroyable

public class ApnsSigningKey
extends ApnsKey
implements ECPrivateKey

A private key used to sign authentication tokens. Signing keys are associated with a developer team (in Apple's parlance), and can be used to sign authentication tokens for any topic associated with that team.

Since:

0.10

Author:

Jon Chambers

See Also:

Serialized Form

Field Summary

Fields inherited from class com.turo.pushy.apns.auth.ApnsKey

APNS_SIGNATURE_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
ApnsSigningKey(String keyId, String teamId, ECPrivateKey key) Constructs a new signing key with the given key identifier, team identifier, and elliptic curve private key.

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm()
byte[]	getEncoded()
String	getFormat()
BigInteger	getS()
static ApnsSigningKey	loadFromInputStream(InputStream inputStream, String teamId, String keyId) Loads a signing key from the given input stream.
static ApnsSigningKey	loadFromPkcs8File(File pkcs8File, String teamId, String keyId) Loads a signing key from the given PKCS#8 file.

Methods inherited from class com.turo.pushy.apns.auth.ApnsKey

getKeyId, getParams, getTeamId

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Methods inherited from interface java.security.interfaces.ECKey

getParams

Constructor Detail

ApnsSigningKey

public ApnsSigningKey(String keyId,
                      String teamId,
                      ECPrivateKey key)
               throws NoSuchAlgorithmException,
                      InvalidKeyException

Constructs a new signing key with the given key identifier, team identifier, and elliptic curve private key.

Parameters:

keyId - the ten-character, Apple-issued identifier for the key itself

teamId - the ten-character, Apple-issued identifier for the team to which the key belongs

key - the elliptic curve public key underpinning this verification key

Throws:

NoSuchAlgorithmException - if the algorith is not supported by the JVM

InvalidKeyException - if the given elliptic curve private key is invalid for any reason

Method Detail

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

getS

public BigInteger getS()

Specified by:

getS in interface ECPrivateKey

loadFromPkcs8File

public static ApnsSigningKey loadFromPkcs8File(File pkcs8File,
                                               String teamId,
                                               String keyId)
                                        throws IOException,
                                               NoSuchAlgorithmException,
                                               InvalidKeyException

Loads a signing key from the given PKCS#8 file.

Parameters:

pkcs8File - the file from which to load the key

teamId - the ten-character, Apple-issued identifier for the team to which the key belongs

keyId - the ten-character, Apple-issued identitifier for the key itself

Returns:

an APNs signing key with the given key ID and associated with the given team

Throws:

IOException - if a key could not be loaded from the given file for any reason

NoSuchAlgorithmException - if the JVM does not support elliptic curve keys

InvalidKeyException - if the loaded key is invalid for any reason

loadFromInputStream

public static ApnsSigningKey loadFromInputStream(InputStream inputStream,
                                                 String teamId,
                                                 String keyId)
                                          throws IOException,
                                                 NoSuchAlgorithmException,
                                                 InvalidKeyException

Loads a signing key from the given input stream.

Parameters:

inputStream - the input stream from which to load the key

teamId - the ten-character, Apple-issued identifier for the team to which the key belongs

keyId - the ten-character, Apple-issued identitifier for the key itself

Returns:

an APNs signing key with the given key ID and associated with the given team

Throws:

IOException - if a key could not be loaded from the given file for any reason

NoSuchAlgorithmException - if the JVM does not support elliptic curve keys

InvalidKeyException - if the loaded key is invalid for any reason