PrivateKeyFile (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.PrivateKeyFile

Direct Known Subclasses:: RouterPrivateKeyFile

public class PrivateKeyFile
extends Object

This helper class reads and writes files in the same "eepPriv.dat" format used by the client code. The format is:

  - Destination (387 bytes if no certificate, otherwise longer)
     - Public key (256 bytes), random data as of 0.9.57 (except for RouterPrivateKeyFile)
     - Signing Public key (128 bytes)
     - Cert. type (1 byte)
     - Cert. length (2 bytes)
     - Certificate if length != 0
  - Private key (256 bytes for ElGamal, or length specified by key certificate)
     -          All zeros as of 0.9.57 (except for RouterPrivateKeyFile)
  - Signing Private key (20 bytes, or length specified by key certificate)
  - As of 0.9.38, if the Signing Private Key is all zeros,
    the offline signature section (see proposal 123):
     - Expires timestamp (4 bytes, seconds since epoch, rolls over in 2106)
     - Sig type of transient public key (2 bytes)
     - Transient Signing Public key (length as specified by transient sig type)
     - Signature of Signed Public key by offline key (length as specified by destination sig type)
     - Transient Signing Private key (length as specified by transient sig type)

 Total: 663 or more bytes for ElGamal, may be smaller for other enc. types

Destination encryption keys have been unused since 0.6 (2005). As of 0.9.57, new Destination encryption public keys are simply random data, and encryption private keys may be random data or all zeros. This class is extended by net.i2p.data.router.RouterPrivateKeyFile. RouterIdentity encryption keys ARE used and must be valid.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Destination`	`dest` the destination
`protected File`	`file` the key file
`protected PrivateKey`	`privKey` the private key
`protected SigningPrivateKey`	`signingPrivKey` the signing private key

Constructor Summary

Constructors
Constructor and Description
`PrivateKeyFile(File file)` Create a new PrivateKeyFile from a File.
`PrivateKeyFile(File file, Destination dest, PrivateKey pk, SigningPrivateKey spk)` Create a new PrivateKeyFile with a destination and keys.
`PrivateKeyFile(File file, I2PClient client)` Create a new PrivateKeyFile with a client.
`PrivateKeyFile(File file, I2PSession session)` Create a new PrivateKeyFile from an I2P session.
`PrivateKeyFile(File file, PublicKey pubkey, SigningPublicKey spubkey, Certificate cert, PrivateKey pk, SigningPrivateKey spk)` Create a new PrivateKeyFile from individual key components.
`PrivateKeyFile(File file, PublicKey pubkey, SigningPublicKey spubkey, Certificate cert, PrivateKey pk, SigningPrivateKey spk, byte[] padding)` Create a new PrivateKeyFile from individual key components with padding.
`PrivateKeyFile(InputStream in)` Read a PrivateKeyFile from an input stream.
`PrivateKeyFile(String file)` Create a new PrivateKeyFile from a file name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`checkSignature(Signature s, byte[] data, SigningPublicKey spk)` Check a signature against data with a public key.
`Destination`	`createIfAbsent()` Create with the default signature type if nonexistent.
`Destination`	`createIfAbsent(SigType type)` Create with the specified signature type if nonexistent.
`Destination`	`getDestination()` If the destination is not set, read it in from the file.
`long`	`getOfflineExpiration()` Get the offline key expiration time.
`Signature`	`getOfflineSignature()` Get the offline signature.
`PrivateKey`	`getPrivKey()` Private key may be random data or all zeros for Destinations as of 0.9.57
`SigningPrivateKey`	`getSigningPrivKey()` Get the signing private key.
`SigningPrivateKey`	`getTransientSigningPrivKey()` Get the transient signing private key.
`SigningPublicKey`	`getTransientSigningPubKey()` Get the transient signing public key.
`boolean`	`isOffline()` Does this session have offline and transient keys?
`static void`	`main(String[] args)` Create a new PrivateKeyFile, or modify an existing one, with various types of Certificates.
`I2PSession`	`open()` Open an I2P session.
`I2PSession`	`open(Properties opts)` Open a session with the given options.
`Certificate`	`setCertType(int t)` Change cert type - caller must also call write().
`void`	`setDestination(Destination d)` Set the destination.
`Certificate`	`setKeyCert(SigType type)` Change cert type - caller must also call write().
`void`	`setOfflineData(long expires, SigningPublicKey transientPub, Signature sig, SigningPrivateKey transientPriv)` Side effect - zeroes out the current signing private key
`Certificate`	`setSignedCert(PrivateKeyFile pkf2)` Sign this dest by dest found in pkf2 - caller must also call write().
`String`	`toString()`
`boolean`	`validateKeyPairs()` Verify that the PublicKey matches the PrivateKey, and the SigningPublicKey matches the SigningPrivateKey.
`static boolean`	`verifySignature(Destination d)` Verify the signature on a destination.
`void`	`write()` Write the keys to the file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - dest
```
protected Destination dest
```
    the destination
  - file
```
protected final File file
```
    the key file
  - privKey
```
protected PrivateKey privKey
```
    the private key
  - signingPrivKey
```
protected SigningPrivateKey signingPrivKey
```
    the signing private key
- Constructor Detail
  - PrivateKeyFile
```
public PrivateKeyFile(File file)
```
    Create a new PrivateKeyFile from a File.
    Parameters:
    file - the key file
  - PrivateKeyFile
```
public PrivateKeyFile(File file,
                      Destination dest,
                      PrivateKey pk,
                      SigningPrivateKey spk)
```
    Create a new PrivateKeyFile with a destination and keys.
    Parameters:
    file - the key file
    dest - the destination
    pk - the private key
    spk - the signing private key
    Throws:
    IllegalArgumentException - on mismatch of spubkey and spk types
  - PrivateKeyFile
```
public PrivateKeyFile(File file,
                      I2PClient client)
```
    Create a new PrivateKeyFile with a client.
    Parameters:
    file - the key file
    client - the I2P client
  - PrivateKeyFile
```
public PrivateKeyFile(File file,
                      I2PSession session)
```
    Create a new PrivateKeyFile from an I2P session.
    Parameters:
    file - the key file
    session - the I2P session
  - PrivateKeyFile
```
public PrivateKeyFile(File file,
                      PublicKey pubkey,
                      SigningPublicKey spubkey,
                      Certificate cert,
                      PrivateKey pk,
                      SigningPrivateKey spk)
```
    Create a new PrivateKeyFile from individual key components.
    Parameters:
    file - the key file
    pubkey - the public key
    spubkey - the signing public key
    cert - the certificate
    pk - the private key
    spk - the signing private key
    Throws:
    IllegalArgumentException - on mismatch of spubkey and spk types
  - PrivateKeyFile
```
public PrivateKeyFile(File file,
                      PublicKey pubkey,
                      SigningPublicKey spubkey,
                      Certificate cert,
                      PrivateKey pk,
                      SigningPrivateKey spk,
                      byte[] padding)
```
    Create a new PrivateKeyFile from individual key components with padding.
    Parameters:
    file - the key file
    pubkey - the public key
    spubkey - the signing public key
    cert - the certificate
    pk - the private key
    spk - the signing private key
    padding - null OK, must be non-null if spubkey length < 128
    Throws:
    IllegalArgumentException - on mismatch of spubkey and spk types
  - PrivateKeyFile
```
public PrivateKeyFile(InputStream in)
               throws I2PSessionException
```
    Read a PrivateKeyFile from an input stream. Can't be used for writing
    Parameters:
    in - the input stream
    Throws:
    I2PSessionException - if session creation fails
  - PrivateKeyFile
```
public PrivateKeyFile(String file)
```
    Create a new PrivateKeyFile from a file name.
    Parameters:
    file - the key file name
- Method Detail
  - checkSignature
```
public static boolean checkSignature(Signature s,
                                     byte[] data,
                                     SigningPublicKey spk)
```
    Check a signature against data with a public key.
    Parameters:
    s - the signature to verify
    data - the data that was signed
    spk - the signing public key
    Returns:
    true if the signature is valid
  - createIfAbsent
```
public Destination createIfAbsent()
                           throws I2PException,
                                  IOException
```
    Create with the default signature type if nonexistent. Also reads in the file to get the privKey and signingPrivKey, which aren't available from I2PClient.
    Returns:
    the destination
    Throws:
    I2PException - if creation fails
    IOException - if file operations fail
  - createIfAbsent
```
public Destination createIfAbsent(SigType type)
                           throws I2PException,
                                  IOException
```
    Create with the specified signature type if nonexistent. Also reads in the file to get the privKey and signingPrivKey, which aren't available from I2PClient.
    Parameters:
    type - the signature type to use
    Returns:
    the destination
    Throws:
    I2PException - if creation fails
    IOException - if file operations fail
  - getDestination
```
public Destination getDestination()
                           throws I2PSessionException,
                                  IOException,
                                  DataFormatException
```
    If the destination is not set, read it in from the file. Also sets the local privKey and signingPrivKey.
    Returns:
    the destination
    Throws:
    I2PSessionException - if reading fails
    IOException - if file operations fail
    DataFormatException - if data is malformed
  - getOfflineExpiration
```
public long getOfflineExpiration()
```
    Get the offline key expiration time.
    Returns:
    Java time (ms) or 0 if not initialized or does not have offline keys
  - getOfflineSignature
```
public Signature getOfflineSignature()
```
    Get the offline signature.
    Returns:
    the signature, or null if not initialized or does not have offline keys
  - getPrivKey
```
public PrivateKey getPrivKey()
```
    Private key may be random data or all zeros for Destinations as of 0.9.57
    Returns:
    null on error or if not initialized
  - getSigningPrivKey
```
public SigningPrivateKey getSigningPrivKey()
```
    Get the signing private key.
    Returns:
    null on error or if not initialized
  - getTransientSigningPrivKey
```
public SigningPrivateKey getTransientSigningPrivKey()
```
    Get the transient signing private key.
    Returns:
    null on error or if not initialized or does not have offline keys
  - getTransientSigningPubKey
```
public SigningPublicKey getTransientSigningPubKey()
```
    Get the transient signing public key.
    Returns:
    null on error or if not initialized or does not have offline keys
  - isOffline
```
public boolean isOffline()
```
    Does this session have offline and transient keys?
    Returns:
    true if offline keys are configured
  - main
```
public static void main(String[] args)
```
    Create a new PrivateKeyFile, or modify an existing one, with various types of Certificates. Changing a Certificate does not change the public or private keys. But it does change the Destination Hash, which effectively makes it a new Destination. In other words, don't change the Certificate on a Destination you've already registered in a hosts.txt key add form. Copied and expanded from that in Destination.java
    Parameters:
    args - command line arguments
  - open
```
public I2PSession open()
                throws I2PSessionException,
                       IOException
```
    Open an I2P session.
    Returns:
    the I2P session
    Throws:
    I2PSessionException - if session creation fails
    IOException - if there is an error reading the key file
  - open
```
public I2PSession open(Properties opts)
                throws I2PSessionException,
                       IOException
```
    Open a session with the given options.
    Parameters:
    opts - the options for the session
    Returns:
    the I2P session
    Throws:
    I2PSessionException - if session creation fails
    IOException - if there is an error reading the key file
  - setCertType
```
public Certificate setCertType(int t)
```
    Change cert type - caller must also call write(). Side effect - creates new Destination object.
    Parameters:
    t - the certificate type
    Returns:
    the certificate
  - setDestination
```
public void setDestination(Destination d)
```
    Set the destination.
    Parameters:
    d - the destination
  - setKeyCert
```
public Certificate setKeyCert(SigType type)
```
    Change cert type - caller must also call write(). Side effect - creates new Destination object.
    Parameters:
    type - the signature type
    Returns:
    the certificate
  - setOfflineData
```
public void setOfflineData(long expires,
                           SigningPublicKey transientPub,
                           Signature sig,
                           SigningPrivateKey transientPriv)
```
    Side effect - zeroes out the current signing private key
    Parameters:
    expires - expiration time in Java ms
    transientPub - the transient signing public key
    sig - the offline signature
    transientPriv - the transient signing private key
  - setSignedCert
```
public Certificate setSignedCert(PrivateKeyFile pkf2)
```
    Sign this dest by dest found in pkf2 - caller must also call write().
    Parameters:
    pkf2 - the signing key file
    Returns:
    the certificate
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
  - validateKeyPairs
```
public boolean validateKeyPairs()
```
    Verify that the PublicKey matches the PrivateKey, and the SigningPublicKey matches the SigningPrivateKey. NOTE this will fail for Destinations containing random padding for the enc. key
    Returns:
    success
  - verifySignature
```
public static boolean verifySignature(Destination d)
```
    Verify the signature on a destination.
    Parameters:
    d - the destination to verify
    Returns:
    true if the signature is valid
  - write
```
public void write()
           throws IOException,
                  DataFormatException
```
    Write the keys to the file. Copied from I2PClientImpl.createDestination()
    Throws:
    IOException - if file operations fail
    DataFormatException - if data encoding fails

Class PrivateKeyFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dest

file

privKey

signingPrivKey

Constructor Detail

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

PrivateKeyFile

Method Detail

checkSignature

createIfAbsent

createIfAbsent

getDestination

getOfflineExpiration

getOfflineSignature

getPrivKey

getSigningPrivKey

getTransientSigningPrivKey

getTransientSigningPubKey

isOffline

main

open

open

setCertType

setDestination

setKeyCert

setOfflineData

setSignedCert

toString

validateKeyPairs

verifySignature

write