org.xwiki.crypto.x509
Interface XWikiX509KeyPair

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultXWikiX509KeyPair

public interface XWikiX509KeyPair
extends java.io.Serializable

Wrapper which contains a PrivateKey and the corresponding XWikiX509Certificate. This class is capable of holding a chain of certificates from the user's certificate back to the root certificate.

Since:

2.5M1

Version:

$Id$

Field Summary

static java.lang.String	BASE64_FOOTER This will be at the end of the output from serializeAsBase64().
static java.lang.String	BASE64_HEADER This will be at the beginning of the output from serializeAsBase64().

Method Summary

XWikiX509Certificate	getCertificate() Get the user's certificate.
java.lang.String	getFingerprint()
java.security.PrivateKey	getPrivateKey(java.lang.String password) Get the private key from the key pair.
java.security.PublicKey	getPublicKey()
byte[]	serialize()
java.lang.String	serializeAsBase64()

Field Detail

BASE64_HEADER

static final java.lang.String BASE64_HEADER

This will be at the beginning of the output from serializeAsBase64().

See Also:

Constant Field Values

BASE64_FOOTER

static final java.lang.String BASE64_FOOTER

This will be at the end of the output from serializeAsBase64().

See Also:

Constant Field Values

Method Detail

getCertificate

XWikiX509Certificate getCertificate()

Get the user's certificate. May throw a RuntimeException if the key pair was deserialized directly using Java deserialization methods without checking that the certificate can be deserialized.

Returns:

the user's certificate

getPublicKey

java.security.PublicKey getPublicKey()

Returns:

the public key

getPrivateKey

java.security.PrivateKey getPrivateKey(java.lang.String password)
                                       throws java.security.GeneralSecurityException

Get the private key from the key pair.

Parameters:

password - the password needed to decrypt the private key.

Returns:

the private key or null if the password is incorrect.

Throws:

java.security.GeneralSecurityException - if the private key cannot be decrypted.

getFingerprint

java.lang.String getFingerprint()

Returns:

certificate fingerprint

serialize

byte[] serialize()
                 throws java.io.IOException

Returns:

this key pair as a byte array, the private key will remain password encrypted as it is in memory.

Throws:

java.io.IOException - if something goes wrong within the serialization framework.

serializeAsBase64

java.lang.String serializeAsBase64()
                                   throws java.io.IOException

Returns:

this key pair serialize()d and converted to a base-64 encoded String.

Throws:

java.io.IOException - if something goes wrong within the serialization framework.