craterdog.security

Interface Notarization

public interface Notarization

This interface defines the methods that must be implemented by all based digital notaries.

Author:

Derk Norton

Field Summary

Fields

Modifier and Type	Field and Description
static int	VALID_FOR_FOREVER For a notary seal that never expires.
static int	VALID_FOR_ONE_DAY For a notary seal that expires after one day.
static int	VALID_FOR_ONE_HOUR For a notary seal that expires after one hour.
static int	VALID_FOR_ONE_MINUTE For a notary seal that expires after one minute.
static int	VALID_FOR_ONE_MONTH For a notary seal that expires after one month (30 days).
static int	VALID_FOR_ONE_WEEK For a notary seal that expires after one week.
static int	VALID_FOR_ONE_YEAR For a notary seal that expires after one year.

Method Summary

Modifier and Type	Method and Description
NotaryKey	deserializeNotaryKey(String json, char[] password) This method de-serializes, from a JSON string, a notary key using the specified password to decrypt the signing key.
boolean	documentIsValid(craterdog.smart.SmartObject<? extends craterdog.smart.SmartObject<?>> document, DigitalSeal seal, PublicKey verificationKey) This method uses the specified public verification key to verify that the specified digital seal is valid for the specified document.
boolean	documentIsValid(String document, DigitalSeal seal, PublicKey verificationKey) This method uses the specified public verification key to verify that the specified digital seal is valid for the specified document.
NotaryKey	generateNotaryKey() This method generates a new notary key consisting of an asymmetric (public/private) key pair based on the algorithm implemented by the specific notary implementation.
Watermark	generateWatermark(int secondsToLive) This method generates a watermark defining the lifetime of a new document as well as the version of the algorithm used to sign and verify the document.
DigitalSeal	notarizeDocument(String documentType, craterdog.smart.SmartObject<? extends craterdog.smart.SmartObject<?>> document, NotaryKey notaryKey) This method generates a digital seal from the specified document using the specified private notary key.
DigitalSeal	notarizeDocument(String documentType, String document, NotaryKey notaryKey) This method generates a digital seal from the specified document using the specified private notary key.
String	serializeNotaryKey(NotaryKey notaryKey, char[] password) This method serializes, as a JSON string, the specified notary key encrypting the private signing key using the specified password.
boolean	watermarkIsValid(Watermark watermark) This method checks to see if the watermark is still valid.

Field Detail

VALID_FOR_ONE_MINUTE

static final int VALID_FOR_ONE_MINUTE

For a notary seal that expires after one minute.

See Also:

Constant Field Values

VALID_FOR_ONE_HOUR

static final int VALID_FOR_ONE_HOUR

For a notary seal that expires after one hour.

See Also:

Constant Field Values

VALID_FOR_ONE_DAY

static final int VALID_FOR_ONE_DAY

For a notary seal that expires after one day.

See Also:

Constant Field Values

VALID_FOR_ONE_WEEK

static final int VALID_FOR_ONE_WEEK

For a notary seal that expires after one week.

See Also:

Constant Field Values

VALID_FOR_ONE_MONTH

static final int VALID_FOR_ONE_MONTH

For a notary seal that expires after one month (30 days).

See Also:

Constant Field Values

VALID_FOR_ONE_YEAR

static final int VALID_FOR_ONE_YEAR

For a notary seal that expires after one year.

See Also:

Constant Field Values

VALID_FOR_FOREVER

static final int VALID_FOR_FOREVER

For a notary seal that never expires.

See Also:

Constant Field Values

Method Detail

generateNotaryKey

NotaryKey generateNotaryKey()

This method generates a new notary key consisting of an asymmetric (public/private) key pair based on the algorithm implemented by the specific notary implementation.

Returns:

The newly generated notary key.

serializeNotaryKey

String serializeNotaryKey(NotaryKey notaryKey,
                          char[] password)

This method serializes, as a JSON string, the specified notary key encrypting the private signing key using the specified password.

Parameters:

notaryKey - The notary key to be serialized.

password - The password to be used to encrypt the signing key.

Returns:

A JSON string representing the notary key.

deserializeNotaryKey

NotaryKey deserializeNotaryKey(String json,
                               char[] password)
                        throws IOException

This method de-serializes, from a JSON string, a notary key using the specified password to decrypt the signing key.

Parameters:

json - The JSON string representing the notary key.

password - The password to be used to decrypt the signing key.

Returns:

The reconstituted notary key.

Throws:

IOException

generateWatermark

Watermark generateWatermark(int secondsToLive)

This method generates a watermark defining the lifetime of a new document as well as the version of the algorithm used to sign and verify the document.

Parameters:

secondsToLive - The number of seconds the document should be valid from the current date and time.

Returns:

The newly generated watermark.

watermarkIsValid

boolean watermarkIsValid(Watermark watermark)

This method checks to see if the watermark is still valid.

Parameters:

watermark - The watermark to be validated.

Returns:

Whether or not the watermark is valid.

notarizeDocument

DigitalSeal notarizeDocument(String documentType,
                             String document,
                             NotaryKey notaryKey)

This method generates a digital seal from the specified document using the specified private notary key.

Parameters:

documentType - The type of document being notarized.

document - The document to be notarized.

notaryKey - The notary key used to notarize the document.

Returns:

The newly generated digital seal.

documentIsValid

boolean documentIsValid(String document,
                        DigitalSeal seal,
                        PublicKey verificationKey)

This method uses the specified public verification key to verify that the specified digital seal is valid for the specified document.

Parameters:

document - The notarized document to be verified.

seal - The digital seal for the document.

verificationKey - The verification key of the notary that signed the document.

Returns:

Whether or not the digital seal is valid.

notarizeDocument

DigitalSeal notarizeDocument(String documentType,
                             craterdog.smart.SmartObject<? extends craterdog.smart.SmartObject<?>> document,
                             NotaryKey notaryKey)

This method generates a digital seal from the specified document using the specified private notary key.

Parameters:

documentType - The type of document being notarized.

document - The document to be notarized.

notaryKey - The notary key used to notarize the document.

Returns:

The newly generated digital seal.

documentIsValid

boolean documentIsValid(craterdog.smart.SmartObject<? extends craterdog.smart.SmartObject<?>> document,
                        DigitalSeal seal,
                        PublicKey verificationKey)

This method uses the specified public verification key to verify that the specified digital seal is valid for the specified document.

Parameters:

document - The notarized document to be verified.

seal - The digital seal for the document.

verificationKey - The verification key of the notary that signed the document.

Returns:

Whether or not the digital seal is valid.