1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.macro

File SignableMacro.java

 

Code metrics

0
0
0
1
58
11
0
-
-
0
-

Classes

Class Line # Actions
SignableMacro 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.macro;
21   
22    import org.xwiki.crypto.pkix.CertificateProvider;
23    import org.xwiki.crypto.signer.param.CMSSignedDataGeneratorParameters;
24    import org.xwiki.crypto.signer.param.CMSSignedDataVerified;
25    import org.xwiki.rendering.block.Block;
26   
27    /**
28    * Mixin interface providing additional signature functionality to a macro.
29    *
30    * @version $Id: 7167191218e3f9e4c3d0a435946eccf6388b4c2e $
31    * @since 6.1M2
32    */
 
33    public interface SignableMacro
34    {
35    /**
36    * Sign the given macro block.
37    *
38    * @param block the block to sign. This block should have a known content source and could be either
39    * a {@link org.xwiki.rendering.block.MacroBlock} or
40    * a {@link org.xwiki.rendering.block.MacroMarkerBlock}.
41    * @param parameters the signature generation parameters.
42    * @throws MacroSignatureException on error.
43    */
44    void sign(Block block, CMSSignedDataGeneratorParameters parameters) throws MacroSignatureException;
45   
46    /**
47    * Verify signature of the given macro block.
48    *
49    * @param block the block to verify. This block should have a known content source and could be either
50    * a {@link org.xwiki.rendering.block.MacroBlock} or
51    * a {@link org.xwiki.rendering.block.MacroMarkerBlock}.
52    * @param certificateProvider a certificate provider providing available certificates.
53    * @return signature verification results, or null no signature where found for the given block.
54    * @throws MacroSignatureException on error.
55    */
56    CMSSignedDataVerified verify(Block block, CertificateProvider certificateProvider)
57    throws MacroSignatureException;
58    }