001 /*
002 * Portions Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 /*
027 * ===========================================================================
028 *
029 * (C) Copyright IBM Corp. 2003 All Rights Reserved.
030 *
031 * ===========================================================================
032 */
033 /*
034 * $Id: XMLSignature.java,v 1.10 2005/05/10 16:03:48 mullan Exp $
035 */
036 package javax.xml.crypto.dsig;
037
038 import javax.xml.crypto.KeySelector;
039 import javax.xml.crypto.KeySelectorResult;
040 import javax.xml.crypto.MarshalException;
041 import javax.xml.crypto.XMLStructure;
042 import javax.xml.crypto.dsig.keyinfo.KeyInfo;
043 import java.security.Signature;
044 import java.util.List;
045
046 /**
047 * A representation of the XML <code>Signature</code> element as
048 * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
049 * W3C Recommendation for XML-Signature Syntax and Processing</a>.
050 * This class contains methods for signing and validating XML signatures
051 * with behavior as defined by the W3C specification. The XML Schema Definition
052 * is defined as:
053 * <pre><code>
054 * <element name="Signature" type="ds:SignatureType"/>
055 * <complexType name="SignatureType">
056 * <sequence>
057 * <element ref="ds:SignedInfo"/>
058 * <element ref="ds:SignatureValue"/>
059 * <element ref="ds:KeyInfo" minOccurs="0"/>
060 * <element ref="ds:Object" minOccurs="0" maxOccurs="unbounded"/>
061 * </sequence>
062 * <attribute name="Id" type="ID" use="optional"/>
063 * </complexType>
064 * </code></pre>
065 * <p>
066 * An <code>XMLSignature</code> instance may be created by invoking one of the
067 * {@link XMLSignatureFactory#newXMLSignature newXMLSignature} methods of the
068 * {@link XMLSignatureFactory} class.
069 *
070 * <p>If the contents of the underlying document containing the
071 * <code>XMLSignature</code> are subsequently modified, the behavior is
072 * undefined.
073 *
074 * <p>Note that this class is named <code>XMLSignature</code> rather than
075 * <code>Signature</code> to avoid naming clashes with the existing
076 * {@link Signature java.security.Signature} class.
077 *
078 * @see XMLSignatureFactory#newXMLSignature(SignedInfo, KeyInfo)
079 * @see XMLSignatureFactory#newXMLSignature(SignedInfo, KeyInfo, List, String, String)
080 * @author Joyce L. Leung
081 * @author Sean Mullan
082 * @author Erwin van der Koogh
083 * @author JSR 105 Expert Group
084 * @since 1.6
085 */
086 public interface XMLSignature extends XMLStructure {
087
088 /**
089 * The XML Namespace URI of the W3C Recommendation for XML-Signature
090 * Syntax and Processing.
091 */
092 final static String XMLNS = "http://www.w3.org/2000/09/xmldsig#";
093
094 /**
095 * Validates the signature according to the
096 * <a href="http://www.w3.org/TR/xmldsig-core/#sec-CoreValidation">
097 * core validation processing rules</a>. This method validates the
098 * signature using the existing state, it does not unmarshal and
099 * reinitialize the contents of the <code>XMLSignature</code> using the
100 * location information specified in the context.
101 *
102 * <p>This method only validates the signature the first time it is
103 * invoked. On subsequent invocations, it returns a cached result.
104 *
105 * @param validateContext the validating context
106 * @return <code>true</code> if the signature passed core validation,
107 * otherwise <code>false</code>
108 * @throws ClassCastException if the type of <code>validateContext</code>
109 * is not compatible with this <code>XMLSignature</code>
110 * @throws NullPointerException if <code>validateContext</code> is
111 * <code>null</code>
112 * @throws XMLSignatureException if an unexpected error occurs during
113 * validation that prevented the validation operation from completing
114 */
115 boolean validate(XMLValidateContext validateContext)
116 throws XMLSignatureException;
117
118 /**
119 * Returns the key info of this <code>XMLSignature</code>.
120 *
121 * @return the key info (may be <code>null</code> if not specified)
122 */
123 KeyInfo getKeyInfo();
124
125 /**
126 * Returns the signed info of this <code>XMLSignature</code>.
127 *
128 * @return the signed info (never <code>null</code>)
129 */
130 SignedInfo getSignedInfo();
131
132 /**
133 * Returns an {@link java.util.Collections#unmodifiableList unmodifiable
134 * list} of {@link XMLObject}s contained in this <code>XMLSignature</code>.
135 *
136 * @return an unmodifiable list of <code>XMLObject</code>s (may be empty
137 * but never <code>null</code>)
138 */
139 List getObjects();
140
141 /**
142 * Returns the optional Id of this <code>XMLSignature</code>.
143 *
144 * @return the Id (may be <code>null</code> if not specified)
145 */
146 String getId();
147
148 /**
149 * Returns the signature value of this <code>XMLSignature</code>.
150 *
151 * @return the signature value
152 */
153 SignatureValue getSignatureValue();
154
155 /**
156 * Signs this <code>XMLSignature</code>.
157 *
158 * <p>If this method throws an exception, this <code>XMLSignature</code> and
159 * the <code>signContext</code> parameter will be left in the state that
160 * it was in prior to the invocation.
161 *
162 * @param signContext the signing context
163 * @throws ClassCastException if the type of <code>signContext</code> is
164 * not compatible with this <code>XMLSignature</code>
165 * @throws NullPointerException if <code>signContext</code> is
166 * <code>null</code>
167 * @throws MarshalException if an exception occurs while marshalling
168 * @throws XMLSignatureException if an unexpected exception occurs while
169 * generating the signature
170 */
171 void sign(XMLSignContext signContext) throws MarshalException,
172 XMLSignatureException;
173
174 /**
175 * Returns the result of the {@link KeySelector}, if specified, after
176 * this <code>XMLSignature</code> has been signed or validated.
177 *
178 * @return the key selector result, or <code>null</code> if a key
179 * selector has not been specified or this <code>XMLSignature</code>
180 * has not been signed or validated
181 */
182 KeySelectorResult getKeySelectorResult();
183
184 /**
185 * A representation of the XML <code>SignatureValue</code> element as
186 * defined in the <a href="http://www.w3.org/TR/xmldsig-core/">
187 * W3C Recommendation for XML-Signature Syntax and Processing</a>.
188 * The XML Schema Definition is defined as:
189 * <p>
190 * <pre>
191 * <element name="SignatureValue" type="ds:SignatureValueType"/>
192 * <complexType name="SignatureValueType">
193 * <simpleContent>
194 * <extension base="base64Binary">
195 * <attribute name="Id" type="ID" use="optional"/>
196 * </extension>
197 * </simpleContent>
198 * </complexType>
199 * </pre>
200 *
201 * @author Sean Mullan
202 * @author JSR 105 Expert Group
203 */
204 public interface SignatureValue extends XMLStructure {
205 /**
206 * Returns the optional <code>Id</code> attribute of this
207 * <code>SignatureValue</code>, which permits this element to be
208 * referenced from elsewhere.
209 *
210 * @return the <code>Id</code> attribute (may be <code>null</code> if
211 * not specified)
212 */
213 String getId();
214
215 /**
216 * Returns the signature value of this <code>SignatureValue</code>.
217 *
218 * @return the signature value (may be <code>null</code> if the
219 * <code>XMLSignature</code> has not been signed yet). Each
220 * invocation of this method returns a new clone of the array to
221 * prevent subsequent modification.
222 */
223 byte[] getValue();
224
225 /**
226 * Validates the signature value. This method performs a
227 * cryptographic validation of the signature calculated over the
228 * <code>SignedInfo</code> of the <code>XMLSignature</code>.
229 *
230 * <p>This method only validates the signature the first
231 * time it is invoked. On subsequent invocations, it returns a cached
232 * result.
233 *
234 * @return <code>true</code> if the signature was
235 * validated successfully; <code>false</code> otherwise
236 * @param validateContext the validating context
237 * @throws NullPointerException if <code>validateContext</code> is
238 * <code>null</code>
239 * @throws XMLSignatureException if an unexpected exception occurs while
240 * validating the signature
241 */
242 boolean validate(XMLValidateContext validateContext)
243 throws XMLSignatureException;
244 }
245 }
|