offapi/com/sun/star/xml/crypto/XXMLSignature.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 signature
  24  *
  25  * <p>This interface represents a XML signer or verifier.</p>
  26  *
  27  * <p>The signer or verifier concrete a key by retrieve signature context and
  28  * signature template.</p>
  29  *
  30  * <p>In some cases, the signer or verifier can determine and locate the
  31  * contents to be signed from the signature template by dereference the URI.</p>
  32  *
  33  * <p>In some cases, the contents to be signed need to be clearly pointed out by
  34  * the signature template.</p>
  35  */
  36 interface XXMLSignature : com::sun::star::uno::XInterface
  37 {
  38     /**
  39      * Perform signature in the environment of signature template and context.
  40      */
  41     com::sun::star::xml::crypto::XXMLSignatureTemplate generate(
  42         [in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
  43         [in] com::sun::star::xml::crypto::XSecurityEnvironment aEnvironment
  44     ) raises( com::sun::star::xml::crypto::XMLSignatureException ,
  45         com::sun::star::uno::SecurityException ) ;
  46
  47     /**
  48      * Perform validation in the environment of signature template and context.
  49      */
  50     com::sun::star::xml::crypto::XXMLSignatureTemplate validate(
  51         [in] com::sun::star::xml::crypto::XXMLSignatureTemplate aTemplate ,
  52         [in] com::sun::star::xml::crypto::XXMLSecurityContext aContext
  53     ) raises( com::sun::star::xml::crypto::XMLSignatureException ,
  54         com::sun::star::uno::SecurityException ) ;
  55
  56     /**
  57      * get the time used by the engine, JSR105,
  58      * this method is used for evaluation.
  59      */
  60      /*
  61     hyper getEngineTime([in] long id);
  62     */
  63 };
  64
  65 } ; } ; } ; } ; } ;
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */