New metadata signer/verifier
[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 org.apache.xml.security.c14n.*;
59 import org.apache.xml.security.signature.*;
60 import org.apache.xml.security.transforms.*;
61 import org.w3c.dom.*;
62
63 import edu.internet2.middleware.shibboleth.common.XML;
64
65 /**
66  *  Signs/verifies/maintains Shibboleth metadata files
67  *
68  * @author     Scott Cantor
69  * @created    June 11, 2002
70  */
71 public class MetadataTool
72 {
73     /**
74      *  Signs/verifies/maintains Shibboleth metadata files
75      *
76      * @param  argv           The command line arguments
77      * @exception  Exception  One of about fifty different kinds of possible errors
78      */
79     public static void main(String args[]) throws Exception {
80         // Process the command line.
81         CmdLineParser parser = new CmdLineParser();
82         CmdLineParser.Option helpOption = parser.addBooleanOption('h', "help");
83         CmdLineParser.Option signOption = parser.addBooleanOption('s', "sign");
84         CmdLineParser.Option inOption = parser.addStringOption('i', "in");
85         CmdLineParser.Option outOption = parser.addStringOption('o', "out");
86         CmdLineParser.Option keystoreOption = parser.addStringOption('k', "keystore");
87         CmdLineParser.Option aliasOption = parser.addStringOption('a', "alias");
88         CmdLineParser.Option pwOption = parser.addStringOption('p', "password");
89         CmdLineParser.Option nsOption = parser.addStringOption('x', "ns");
90         CmdLineParser.Option nameOption = parser.addStringOption('n', "name");
91
92         try {
93             parser.parse(args);
94         }
95         catch (CmdLineParser.OptionException e) {
96             System.err.println(e.getMessage());
97             try {
98                 Thread.sleep(100); //silliness to get error to print first
99             }
100             catch (InterruptedException ie) {
101                 //doesn't matter
102             }
103             printUsage(System.out);
104             System.exit(-1);
105         }
106
107         Boolean helpEnabled = (Boolean)parser.getOptionValue(helpOption);
108         if (helpEnabled != null && helpEnabled.booleanValue()) {
109             printUsage(System.out);
110             System.exit(0);
111         }
112         
113         Boolean sign = (Boolean)parser.getOptionValue(signOption);
114         String keystore = (String)parser.getOptionValue(keystoreOption);
115         String pw = (String)parser.getOptionValue(pwOption);
116         String alias = (String)parser.getOptionValue(aliasOption);
117         String infile = (String)parser.getOptionValue(inOption);
118         String outfile = (String)parser.getOptionValue(outOption);
119         String ns = (String)parser.getOptionValue(nsOption);
120         String name = (String)parser.getOptionValue(nameOption);
121
122         if (infile == null || infile.length() == 0) {
123             printUsage(System.out);
124             System.exit(1);
125         }
126         
127         if (keystore != null && keystore.length() > 0) {
128             if (alias == null || alias.length() == 0) {
129                 printUsage(System.out);
130                 System.exit(1);
131             }
132         }
133
134         PrivateKey privateKey = null;
135         Certificate chain[] = null;
136         X509Certificate cert = null;
137         
138         if (sign != null && sign.booleanValue()) {
139             if (keystore == null || keystore.length() == 0 || pw == null || pw.length() == 0) {
140                 printUsage(System.out);
141                 System.exit(1);
142             }
143             KeyStore ks = KeyStore.getInstance("JKS");
144             FileInputStream fis = new FileInputStream(keystore);
145             ks.load(fis, pw.toCharArray());
146             privateKey = (PrivateKey)ks.getKey(alias, pw.toCharArray());
147             chain = ks.getCertificateChain(alias);
148             if (privateKey == null || chain == null) {
149                 System.err.println("error: couldn't load key or certificate chain from keystore");
150                 System.exit(1);
151             }
152         }
153         else if (keystore != null && keystore.length() > 0){
154             KeyStore ks = KeyStore.getInstance("JKS");
155             FileInputStream fis = new FileInputStream(keystore);
156             ks.load(fis, null);
157             cert = (X509Certificate)ks.getCertificate(alias);
158             if (cert == null) {
159                 System.err.println("error: couldn't load certificate from keystore");
160                 System.exit(1);
161             }
162         }
163         
164         org.opensaml.XML.parserPool.registerSchema(XML.SHIB_NS, XML.SHIB_SCHEMA_ID, new XML.SchemaResolver());
165         org.opensaml.XML.parserPool.registerSchema(XML.TRUST_NS, XML.TRUST_SCHEMA_ID, new XML.SchemaResolver());
166         
167         // Parse file and verify root element.
168         Document doc = org.opensaml.XML.parserPool.parse(infile);
169         Element e = doc.getDocumentElement();
170         if (ns != null && name != null && !org.opensaml.XML.isElementNamed(e,ns,name)) {
171             System.err.println("error: root element did not match ns and name parameters");
172             System.exit(1);
173         }
174         else if (!org.opensaml.XML.isElementNamed(e,XML.SHIB_NS,"SiteGroup") &&
175                             !org.opensaml.XML.isElementNamed(e,XML.SHIB_NS,"Trust") &&
176                                         !org.opensaml.XML.isElementNamed(e,XML.TRUST_NS,"Trust")) {
177             System.err.println("error: root element must be shib:SiteGroup, shib:Trust, or trust:Trust");
178             System.exit(1);
179         }
180
181         if (sign != null && sign.booleanValue()) {
182             // Remove any existing signature.
183             Element old = org.opensaml.XML.getLastChildElement(e, org.opensaml.XML.XMLSIG_NS, "Signature");
184             if (old != null)
185                 e.removeChild(old);
186
187             // Create new signature.
188             XMLSignature sig = new XMLSignature(doc, null, XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1);
189             Transforms transforms = new Transforms(doc);
190             transforms.addTransform(Transforms.TRANSFORM_ENVELOPED_SIGNATURE);
191             transforms.addTransform(Transforms.TRANSFORM_C14N_EXCL_OMIT_COMMENTS);
192             sig.addDocument("", transforms, org.apache.xml.security.utils.Constants.ALGO_ID_DIGEST_SHA1);
193             for (int i=0; i < chain.length; i++)
194                 sig.addKeyInfo((X509Certificate)chain[i]);
195             e.appendChild(sig.getElement());
196             sig.sign(privateKey);
197         }
198         else if (cert != null) {
199             Element sigElement = org.opensaml.XML.getLastChildElement(e, org.opensaml.XML.XMLSIG_NS, "Signature");
200             if (sigElement == null) {
201                 System.err.println("error: file was not signed");
202                 System.exit(1);
203             }
204             XMLSignature sig = new XMLSignature(sigElement, null);
205             if (!sig.checkSignatureValue(cert)) {
206                 System.err.println("error: signature on file did not verify");
207                 System.exit(1);
208             }
209         }
210         
211         OutputStream out = null;
212         Canonicalizer c = Canonicalizer.getInstance(Canonicalizer.ALGO_ID_C14N_EXCL_WITH_COMMENTS);
213         if (outfile != null && outfile.length() > 0) {
214             out = new FileOutputStream(outfile);
215             out.write(c.canonicalizeSubtree(doc));
216             out.close();
217         }
218         else {
219                 System.out.write(c.canonicalizeSubtree(doc));
220         }
221     }
222
223     private static void printUsage(PrintStream out)
224     {
225
226         out.println("usage: java edu.internet2.middleware.shibboleth.utils.MetadataTool");
227         out.println();
228         out.println("when signing:   -i <uri> -s -k <keystore> -a <alias> -p <pass> [-o <outfile>]");
229         out.println("when updating:  -i <uri> [-k <keystore> -a <alias> -o <outfile>]");
230         out.println("  -i,--in              input file or url");
231         out.println("  -k,--keystore        pathname of Java keystore file");
232         out.println("  -a,--alias           alias of signing or verification key");
233         out.println("  -p,--password        keystore/key password");
234         out.println("  -o,--outfile         write signed copy to this file instead of stdout");
235         out.println("  -s,--sign            sign the input file and write out a signed version");
236         out.println("  -h,--help            print this message");
237         out.println("  -x,--ns              XML namespace of root element");
238         out.println("  -n,--name            name of root element");
239         out.println();
240         System.exit(1);
241     }
242 }
243