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