xref: /aoo42x/main/offapi/com/sun/star/xml/crypto/XXMLSignature.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



//i20156 - new file for xmlsecurity module

/** -- idl definition -- **/

#ifndef __com_sun_star_xml_crypto_xxmlsignature_idl_
#define __com_sun_star_xml_crypto_xxmlsignature_idl_

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/uno/SecurityException.idl>

#include <com/sun/star/xml/crypto/XXMLSignatureTemplate.idl>
#include <com/sun/star/xml/crypto/XXMLSecurityContext.idl>
#include <com/sun/star/xml/crypto/XMLSignatureException.idl>

module com { module sun { module star { module xml { module crypto {

/**
 * Interface of XML signature
 *
 * <p>This interface represents a xml signer or vertifier.</p>
 *
 * <p>The signer or vertifier concrete a key by retrieve signature context and
 * signature template.</p>
 *
 * <p>In some cases, the signer or vertifier can dertermine and locate the
 * contents to be signed from the signature template by dereference the URI.</p>
 *
 * <p>In some cases, the contents to be signed need to be clearly pointed out by
 * the signature template.</p>
 */
interface XXMLSignature : com::sun::star::uno::XInterface
{
	/**
	 * Perform signature in the environment of signature template and context.
	 */
	com::sun::star::xml::crypto::XXMLSignatureTemplate generate(
		[in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
		[in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
	) raises( com::sun::star::xml::crypto::XMLSignatureException ,
		com::sun::star::uno::SecurityException ) ;

	/**
	 * Perform validation in the environment of signature template and context.
	 */
	com::sun::star::xml::crypto::XXMLSignatureTemplate validate(
		[in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
		[in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
	) raises( com::sun::star::xml::crypto::XMLSignatureException ,
		com::sun::star::uno::SecurityException ) ;

	/**
	 * get the time used by the engine, JSR105,
	 * this method is used for evaluation.
	 */
	 /*
	hyper getEngineTime([in] long id);
	*/
};

} ; } ; } ; } ; } ;
#endif