1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir//i20156 - new file for xmlsecurity module
25cdf0e10cSrcweir
26cdf0e10cSrcweir/** -- idl definition -- **/
27cdf0e10cSrcweir
28cdf0e10cSrcweir#ifndef __com_sun_star_xml_crypto_xxmlencryption_idl_
29cdf0e10cSrcweir#define __com_sun_star_xml_crypto_xxmlencryption_idl_
30cdf0e10cSrcweir
31cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
32cdf0e10cSrcweir#include <com/sun/star/uno/Exception.idl>
33cdf0e10cSrcweir#include <com/sun/star/uno/SecurityException.idl>
34cdf0e10cSrcweir
35cdf0e10cSrcweir#include <com/sun/star/xml/crypto/XXMLEncryptionTemplate.idl>
36cdf0e10cSrcweir#include <com/sun/star/xml/wrapper/XXMLElementWrapper.idl>
37cdf0e10cSrcweir#include <com/sun/star/xml/crypto/XXMLSecurityContext.idl>
38cdf0e10cSrcweir#include <com/sun/star/xml/crypto/XMLEncryptionException.idl>
39cdf0e10cSrcweir
40cdf0e10cSrcweir
41cdf0e10cSrcweirmodule com { module sun { module star { module xml { module crypto {
42cdf0e10cSrcweir
43cdf0e10cSrcweir/**
44cdf0e10cSrcweir * Interface of XML encryption
45cdf0e10cSrcweir *
46cdf0e10cSrcweir * <p>This interface represents a xml encrypter or decrypter.</p>
47cdf0e10cSrcweir *
48cdf0e10cSrcweir * <p>The encrypter or decrypter concrete a key by retrieve security context
49cdf0e10cSrcweir * and encryption template.</p>
50cdf0e10cSrcweir *
51cdf0e10cSrcweir * <p>In some cases, the encrypter or decrypter can dertermine and locate the
52cdf0e10cSrcweir * EncrytedKey from the encryption template by dereference the RetrievalMethod
53cdf0e10cSrcweir * inside EncryptedData.</p>
54cdf0e10cSrcweir *
55cdf0e10cSrcweir * <p>In some cases, the EncryptedKey need to be clearly pointed out by the
56cdf0e10cSrcweir * encryption template.</p>
57cdf0e10cSrcweir */
58cdf0e10cSrcweirinterface XXMLEncryption : com::sun::star::uno::XInterface
59cdf0e10cSrcweir{
60cdf0e10cSrcweir	/**
61cdf0e10cSrcweir	 * Perform encryption in the environment of encryption template and context.
62cdf0e10cSrcweir	 */
63cdf0e10cSrcweir	com::sun::star::xml::crypto::XXMLEncryptionTemplate encrypt(
64cdf0e10cSrcweir		[in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
65cdf0e10cSrcweir		[in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
66cdf0e10cSrcweir	) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
67cdf0e10cSrcweir		com::sun::star::uno::SecurityException ) ;
68cdf0e10cSrcweir
69cdf0e10cSrcweir	/**
70cdf0e10cSrcweir	 * Perform decryption in the environment of encrytpion template and context.
71cdf0e10cSrcweir	 */
72cdf0e10cSrcweir	com::sun::star::xml::crypto::XXMLEncryptionTemplate decrypt(
73cdf0e10cSrcweir		[in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
74cdf0e10cSrcweir		[in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
75cdf0e10cSrcweir	) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
76cdf0e10cSrcweir		com::sun::star::uno::SecurityException ) ;
77cdf0e10cSrcweir} ;
78cdf0e10cSrcweir
79cdf0e10cSrcweir} ; } ; } ; } ; } ;
80cdf0e10cSrcweir
81cdf0e10cSrcweir
82cdf0e10cSrcweir#endif
83cdf0e10cSrcweir
84