offapi/com/sun/star/xml/crypto/XXMLEncryption.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module xml { module crypto {
  21
  22 /**
  23  * Interface of XML encryption
  24  *
  25  * <p>This interface represents a XML encryptor or decryptor.</p>
  26  *
  27  * <p>The encryptor or decryptor concrete a key by retrieve security context
  28  * and encryption template.</p>
  29  *
  30  * <p>In some cases, the encryptor or decryptor can determine and locate the
  31  * EncryptedKey from the encryption template by dereference the RetrievalMethod
  32  * inside EncryptedData.</p>
  33  *
  34  * <p>In some cases, the EncryptedKey need to be clearly pointed out by the
  35  * encryption template.</p>
  36  */
  37 interface XXMLEncryption : com::sun::star::uno::XInterface
  38 {
  39     /**
  40      * Perform encryption in the environment of encryption template and context.
  41      */
  42     com::sun::star::xml::crypto::XXMLEncryptionTemplate encrypt(
  43         [in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
  44         [in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
  45     ) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
  46         com::sun::star::uno::SecurityException ) ;
  47
  48     /**
  49      * Perform decryption in the environment of encryption template and context.
  50      */
  51     com::sun::star::xml::crypto::XXMLEncryptionTemplate decrypt(
  52         [in] com::sun::star::xml::crypto::XXMLEncryptionTemplate aTemplate ,
  53         [in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
  54     ) raises( com::sun::star::xml::crypto::XMLEncryptionException ,
  55         com::sun::star::uno::SecurityException ) ;
  56 } ;
  57
  58 } ; } ; } ; } ; } ;
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */