1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_xml_crypto_xciphercontextsupplier_idl_
24#define __com_sun_star_xml_crypto_xciphercontextsupplier_idl_
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_NamedValue_idl__
31#include <com/sun/star/beans/NamedValue.idl>
32#endif
33
34#ifndef __com_sun_star_xml_crypto_XCipherContext_idl__
35#include <com/sun/star/xml/crypto/XCipherContext.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42//============================================================================
43
44 module com {  module sun {  module star {  module xml { module crypto {
45
46//============================================================================
47/** This interface allows to get an object that allows to encrypt/decrypt data
48    using the specified algorithm.
49
50    @since OOo 3.4
51 */
52interface XCipherContextSupplier : com::sun::star::uno::XInterface
53{
54    //------------------------------------------------------------------------
55    /** returns an object that allows to encrypt/decrypt data.
56
57        @param nCipherID
58            the internal ID specifying the algorithm,
59            should take value from <type>CipherID</type>
60
61        @param aKey
62            the key that should be used for the encryption
63
64        @param aInitializationVector
65            the initialization vector that should be used for the encryption
66
67        @param bEncryption
68            whether an encryption or decryption cipher should be created
69            <TRUE/> - Encryption
70            <FALSE/> - Decryption
71
72        @param aParams
73            optional parameters that could be used to initialize the cipher,
74
75        @throws ::com::sun::star::lang::IllegalArgumentException
76            one of provided arguments is illegal
77     */
78
79    XCipherContext getCipherContext( [in] long nCipherID, [in] sequence< byte > aKey, [in] sequence< byte > aInitializationVector, [in] boolean bEncryption, [in] sequence< ::com::sun::star::beans::NamedValue > aParams )
80        raises( ::com::sun::star::lang::IllegalArgumentException );
81};
82
83//============================================================================
84
85}; }; }; }; };
86
87#endif
88