net.java.truelicense.core.auth

Class Notary

java.lang.Object

net.java.truelicense.core.auth.Notary

All Implemented Interfaces:

Authentication, AuthenticationParametersProvider

@Immutable
public final class Notary
extends Object
implements Authentication

Signs or verifies repositories with an entry in a key store.

Author:

Christian Schlichtherle

Constructor Summary

Constructors

Constructor and Description
Notary(KeyStoreParameters ksp)

Method Summary

Modifier and Type	Method and Description
KeyStoreParameters	parameters() Returns the authentication parameters.
Artifactory	sign(Codec codec, Repository repository, Object artifact) Encodes and signs the given artifact in the provided repository and returns an artifactory for decoding it.
Artifactory	verify(Codec codec, Repository repository) Verifies the signature of the encoded artifact in the provided repository and returns an artifactory for decoding it.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notary

public Notary(KeyStoreParameters ksp)

Method Detail

parameters

public KeyStoreParameters parameters()

Description copied from interface: AuthenticationParametersProvider

Returns the authentication parameters.

Specified by:

parameters in interface AuthenticationParametersProvider

sign

public Artifactory sign(Codec codec,
                        Repository repository,
                        @Nullable
                        Object artifact)
                 throws Exception

Description copied from interface: Authentication

Encodes and signs the given artifact in the provided repository and returns an artifactory for decoding it. After calling this method, the repository typically gets encoded for future decoding and verification.

Specified by:

sign in interface Authentication

Parameters:

codec - the codec for encoding the artifact. It is an implementation detail whether or not encoding null is supported or not.

repository - the repository for encoding the artifact to.

artifact - the nullable artifact to sign. This may be null if and only if the codec supports encoding it.

Returns:

An Artifactory for decoding the signed artifact in the repository.

Throws:

Exception

verify

public Artifactory verify(Codec codec,
                          Repository repository)
                   throws Exception

Description copied from interface: Authentication

Verifies the signature of the encoded artifact in the provided repository and returns an artifactory for decoding it. Calling this method generally requires prior initialization of the repository. Though initialization is a side effect of calling Authentication.sign(net.java.truelicense.core.codec.Codec, net.java.truelicense.core.auth.Repository, java.lang.Object), this is typically done by decoding the repository itself.

Specified by:

verify in interface Authentication

Parameters:

codec - the codec for decoding the artifact. It is an implementation detail whether or not decoding null is supported or not.

repository - the repository for decoding the artifact from.

Returns:

An Artifactory for decoding the verified artifact in the repository.

Throws:

RepositoryIntegrityException - if the integrity of the repository with its encoded artifact has been compromised.

Exception