org.projecthusky.xua.crypt.SignCryptModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of husky-xua-gen-api Show documentation
There is a newer version: 2.5.2
/*
 * This code is made available under the terms of the Eclipse Public License v1.0 
 * in the github project https://github.com/project-husky/husky there you also 
 * find a list of the contributors and the license information.
 * 
 * This project has been developed further and modified by the joined working group Husky 
 * on the basis of the eHealth Connector opensource project from June 28, 2021, 
 * whereas medshare GmbH is the initial and main contributor/author of the eHealth Connector.
 *
 */
package org.projecthusky.xua.crypt;

import java.security.KeyStore;

import org.projecthusky.xua.authentication.AuthnRequest;
import org.projecthusky.xua.exceptions.SigningException;
import org.projecthusky.xua.saml2.ArtifactResolve;

/**
 *
 * 
 * Interface describing the methods of the sign and crypt module.
 * Interface welches die Methoden des sign und crypt modules beschreibt.
 * 
 * 
 * 
 *
 */
public interface SignCryptModule {

	/**
	 *
	 * 
	 * Method to set the key and truststore and the corresponding passwords.
	 * Methode um den key und trust store und deren Passwörter zu setzen.
	 * 
	 * 
	 *
	 * @param keyStore
	 *  the keystore to be set.
	 *  der Keystore der gesetzt werden soll.
	 *  
	 *  
	 * @param aKeyStorePassword
	 * 	the password of the keystore to be set.
	 *  das Passwort zum Keystore
	 *  
	 *  
	 * @param trustStore
	 *  the truststore to be set.
	 *  der Truststore der gesetzt werden soll.
	 *  
	 *  
	 * @param aTrustStorePassword
	 *  the password of the truststore to be set.
	 *  das Passwort zum Truststore
	 *  
	 *  
	 * 
	 */
	void setPki(KeyStore keyStore, String aKeyStorePassword, KeyStore trustStore,
			String aTrustStorePassword);

	void signArtifactResolve(ArtifactResolve artifactResolve, String aSigningAlias)
			throws SigningException;

	/**
	 *
	 * 
	 * Method to sign an AuthnRequest.
	 * Methode um einen AuthnRequest zu signieren.
	 * 
	 * 
	 * 
	 *
	 * @param aAuthnRequest
	 * the AuthnRequest to be signed
	 *  der AuthnRequest der signiert werden soll
	 *  
	 *  
	 * @param aSigningAlias
	 * the alias of the key in the keystore to be used for signing
	 *  der Alias des Keys aus dem Keystore welcher zum signieren gebraucht werden soll
	 *  
	 *  
	 * @throws SigningException
	 * will be thrown when an error occures signing the AuthnRequest
	 *  wird geworfen wenn ein Fehler beim Signieren des Authnrequests auftritt
	 *  
	 *  
	 */
	void signAuthnRequest(AuthnRequest aAuthnRequest, String aSigningAlias) throws SigningException;

}