Fixed KeyInfo and Signature placement bugs.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / utils / MetadataTool.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.utils;
51
52 import jargs.gnu.CmdLineParser;
53
54 import java.io.*;
55 import java.security.*;
56 import java.security.cert.Certificate;
57 import java.security.cert.*;
58 import java.util.Iterator;
59
60 import org.apache.log4j.ConsoleAppender;
61 import org.apache.log4j.Level;
62 import org.apache.log4j.Logger;
63 import org.apache.log4j.PatternLayout;
64 import org.apache.xml.security.c14n.*;
65 import org.apache.xml.security.keys.KeyInfo;
66 import org.apache.xml.security.keys.content.X509Data;
67 import org.apache.xml.security.signature.*;
68 import org.apache.xml.security.transforms.*;
69 import org.w3c.dom.*;
70
71 import edu.internet2.middleware.shibboleth.common.XML;
72 import edu.internet2.middleware.shibboleth.xml.Parser;
73
74 /**
75  *  Signs/verifies/maintains Shibboleth metadata files
76  *
77  * @author     Scott Cantor
78  * @created    June 11, 2002
79  */
80 public class MetadataTool
81 {
82     /**
83      *  Signs/verifies/maintains Shibboleth metadata files
84      *
85      * @param  argv           The command line arguments
86      * @exception  Exception  One of about fifty different kinds of possible errors
87      */
88     public static void main(String args[]) throws Exception {
89         // Process the command line.
90         CmdLineParser parser = new CmdLineParser();
91         CmdLineParser.Option helpOption = parser.addBooleanOption('h', "help");
92         CmdLineParser.Option signOption = parser.addBooleanOption('s', "sign");
93         CmdLineParser.Option noverifyOption = parser.addBooleanOption('N', "noverify");
94         CmdLineParser.Option inOption = parser.addStringOption('i', "in");
95         CmdLineParser.Option outOption = parser.addStringOption('o', "out");
96         CmdLineParser.Option keystoreOption = parser.addStringOption('k', "keystore");
97         CmdLineParser.Option aliasOption = parser.addStringOption('a', "alias");
98         CmdLineParser.Option pwOption = parser.addStringOption('p', "password");
99         CmdLineParser.Option nsOption = parser.addStringOption('x', "ns");
100         CmdLineParser.Option nameOption = parser.addStringOption('n', "name");
101         CmdLineParser.Option debugOption = parser.addBooleanOption('d', "debug");
102                 
103                 Boolean debugEnabled = ((Boolean) parser.getOptionValue(debugOption));
104                 boolean debug = false;
105                 if (debugEnabled != null) {
106                         debug = debugEnabled.booleanValue();
107                 }
108         configureLogging(debug);
109         
110         try {
111             parser.parse(args);
112         }
113         catch (CmdLineParser.OptionException e) {
114             System.err.println(e.getMessage());
115             try {
116                 Thread.sleep(100); //silliness to get error to print first
117             }
118             catch (InterruptedException ie) {
119                 //doesn't matter
120             }
121             printUsage(System.out);
122             System.exit(-1);
123         }
124
125         Boolean helpEnabled = (Boolean)parser.getOptionValue(helpOption);
126         if (helpEnabled != null && helpEnabled.booleanValue()) {
127             printUsage(System.out);
128             System.exit(0);
129         }
130         
131         Boolean sign = (Boolean)parser.getOptionValue(signOption);
132         Boolean noverify = (Boolean)parser.getOptionValue(noverifyOption);
133         String keystore = (String)parser.getOptionValue(keystoreOption);
134         String pw = (String)parser.getOptionValue(pwOption);
135         String alias = (String)parser.getOptionValue(aliasOption);
136         String infile = (String)parser.getOptionValue(inOption);
137         String outfile = (String)parser.getOptionValue(outOption);
138         String ns = (String)parser.getOptionValue(nsOption);
139         String name = (String)parser.getOptionValue(nameOption);
140
141         if (infile == null || infile.length() == 0) {
142             printUsage(System.out);
143             System.exit(1);
144         }
145         
146         if (keystore != null && keystore.length() > 0) {
147             if (alias == null || alias.length() == 0) {
148                 printUsage(System.out);
149                 System.exit(1);
150             }
151         }
152
153         PrivateKey privateKey = null;
154         Certificate chain[] = null;
155         X509Certificate cert = null;
156         
157         if (sign != null && sign.booleanValue()) {
158             if (keystore == null || keystore.length() == 0 || pw == null || pw.length() == 0) {
159                 printUsage(System.out);
160                 System.exit(1);
161             }
162             KeyStore ks = KeyStore.getInstance("JKS");
163             FileInputStream fis = new FileInputStream(keystore);
164             ks.load(fis, pw.toCharArray());
165             privateKey = (PrivateKey)ks.getKey(alias, pw.toCharArray());
166             chain = ks.getCertificateChain(alias);
167             if (privateKey == null || chain == null) {
168                 System.err.println("error: couldn't load key or certificate chain from keystore");
169                 System.exit(1);
170             }
171         }
172         else if (keystore != null && keystore.length() > 0){
173             KeyStore ks = KeyStore.getInstance("JKS");
174             FileInputStream fis = new FileInputStream(keystore);
175             ks.load(fis, null);
176             cert = (X509Certificate)ks.getCertificate(alias);
177             if (cert == null) {
178                 System.err.println("error: couldn't load certificate from keystore");
179                 System.exit(1);
180             }
181         }
182         else if (noverify == null || !noverify.booleanValue()) {
183             printUsage(System.out);
184             System.exit(1);
185         }
186         
187         
188         // Parse file and verify root element.
189         Document doc = Parser.loadDom(infile,true);
190         Element e = doc.getDocumentElement();
191         if (ns != null && name != null && !org.opensaml.XML.isElementNamed(e,ns,name)) {
192             System.err.println("error: root element did not match ns and name parameters");
193             System.exit(1);
194         }
195         else if (!org.opensaml.XML.isElementNamed(e,XML.SHIB_NS,"SiteGroup") &&
196                             !org.opensaml.XML.isElementNamed(e,XML.SHIB_NS,"Trust") &&
197                                         !org.opensaml.XML.isElementNamed(e,XML.TRUST_NS,"Trust") &&
198                     !org.opensaml.XML.isElementNamed(e,XML.SAML2META_NS,"EntityDescriptor") &&
199                     !org.opensaml.XML.isElementNamed(e,XML.SAML2META_NS,"EntitiesDescriptor")) {
200             System.err.println("error: root element must be SiteGroup, Trust, EntitiesDescriptor, or EntityDescriptor");
201             System.exit(1);
202         }
203
204         if (sign != null && sign.booleanValue()) {
205             // Remove any existing signature.
206             Element old = org.opensaml.XML.getFirstChildElement(e, org.opensaml.XML.XMLSIG_NS, "Signature");
207             if (old != null)
208                 e.removeChild(old);
209
210             // Create new signature.
211             XMLSignature sig = new XMLSignature(doc, "", XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1, Canonicalizer.ALGO_ID_C14N_EXCL_WITH_COMMENTS);
212             Transforms transforms = new Transforms(doc);
213             transforms.addTransform(Transforms.TRANSFORM_ENVELOPED_SIGNATURE);
214             transforms.addTransform(Transforms.TRANSFORM_C14N_EXCL_WITH_COMMENTS);
215             sig.addDocument("", transforms, org.apache.xml.security.utils.Constants.ALGO_ID_DIGEST_SHA1);
216
217             // Add any X.509 certificates provided.
218             if (chain!=null && chain.length > 0) {
219                 X509Data x509 = new X509Data(e.getOwnerDocument());
220                 for (int i=0; i < chain.length; i++) {
221                     if (chain[i] instanceof X509Certificate)
222                         x509.addCertificate((X509Certificate)chain[i]);
223                 }
224                 KeyInfo keyinfo = new KeyInfo(e.getOwnerDocument());
225                 keyinfo.add(x509);
226                 sig.getElement().appendChild(keyinfo.getElement());
227             }
228
229             if (XML.SAML2META_NS.equals(e.getNamespaceURI()))
230                 e.insertBefore(sig.getElement(),e.getFirstChild());
231             else
232                 e.appendChild(sig.getElement());
233             sig.sign(privateKey);
234         }
235         else {
236             Element sigElement = org.opensaml.XML.getLastChildElement(e, org.opensaml.XML.XMLSIG_NS, "Signature");
237             boolean v = (noverify == null || !noverify.booleanValue());
238             if (v) {
239                 if (sigElement == null) {
240                     System.err.println("error: file is not signed");
241                     System.exit(1);
242                 }
243                 XMLSignature sig = new XMLSignature(sigElement, "");
244                 if (!sig.checkSignatureValue(cert)) {
245                     System.err.println("error: signature on file did not verify");
246                     System.exit(1);
247                 }
248             }
249             else if (sigElement != null) {
250                 XMLSignature sig = new XMLSignature(sigElement, "");
251                 System.err.println("verification of signer disabled, make sure you trust the source of this file!");
252                 if (!sig.checkSignatureValue(sig.getKeyInfo().getPublicKey())) {
253                     System.err.println("error: signature on file did not verify");
254                     System.exit(1);
255                 }
256             }
257             else {
258                 System.err.println("verification disabled, and file is unsigned!");
259             }
260         }
261         
262         Canonicalizer c = Canonicalizer.getInstance(Canonicalizer.ALGO_ID_C14N_EXCL_WITH_COMMENTS);
263         if (outfile != null && outfile.length() > 0) {
264             OutputStream out = new FileOutputStream(outfile);
265             out.write(c.canonicalizeSubtree(doc));
266             out.close();
267         }
268         else {
269                 System.out.write(c.canonicalizeSubtree(doc));
270         }
271     }
272
273     private static void printUsage(PrintStream out)
274     {
275
276         out.println("usage: java edu.internet2.middleware.shibboleth.utils.MetadataTool");
277         out.println();
278         out.println("when signing:   -i <uri> -s -k <keystore> -a <alias> -p <pass> [-o <outfile>]");
279         out.println("when updating:  -i <uri> [-k <keystore> -a <alias> OR -N ] [-o <outfile>]");
280         out.println("  -i,--in              input file or url");
281         out.println("  -k,--keystore        pathname of Java keystore file");
282         out.println("  -a,--alias           alias of signing or verification key");
283         out.println("  -p,--password        keystore/key password");
284         out.println("  -o,--outfile         write signed copy to this file instead of stdout");
285         out.println("  -s,--sign            sign the input file and write out a signed version");
286         out.println("  -N,--noverify        allows update of file without signature check");
287         out.println("  -h,--help            print this message");
288         out.println("  -x,--ns              XML namespace of root element");
289         out.println("  -n,--name            name of root element");
290         out.println("  -d, --debug          run in debug mode");
291         out.println();
292         System.exit(1);
293     }
294     
295         private static void configureLogging(boolean debugEnabled) 
296         {
297                 ConsoleAppender rootAppender = new ConsoleAppender();
298                 rootAppender.setWriter(new PrintWriter(System.out));
299                 rootAppender.setName("stdout");
300                 Logger.getRootLogger().addAppender(rootAppender);
301
302                 if (debugEnabled) {
303                         Logger.getRootLogger().setLevel(Level.DEBUG);
304                         rootAppender.setLayout(new PatternLayout("%-5p %-41X{serviceId} %d{ISO8601} (%c:%L) - %m%n")); 
305                 } else {
306                         Logger.getRootLogger().setLevel(Level.INFO);
307                         Logger.getLogger("edu.internet2.middleware.shibboleth.aa.attrresolv").setLevel(Level.WARN);
308                         rootAppender.setLayout(new PatternLayout(PatternLayout.TTCC_CONVERSION_PATTERN)); 
309                 }
310                 Logger.getLogger("org.apache.xml.security").setLevel(Level.OFF);
311         }
312 }
313