2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* siterefresh.cpp - command-line tool to refresh and verify metadata
22 $Id:siterefresh.cpp 2252 2007-05-20 20:20:57Z cantor $
25 #if defined (_MSC_VER) || defined(__BORLANDC__)
26 # include "config_win32.h"
32 # define _CRT_NONSTDC_NO_DEPRECATE 1
33 # define _CRT_SECURE_NO_DEPRECATE 1
36 #include <saml/SAMLConfig.h>
37 #include <saml/saml2/metadata/Metadata.h>
38 #include <saml/saml2/metadata/MetadataProvider.h>
39 #include <saml/saml2/metadata/MetadataCredentialCriteria.h>
40 #include <saml/signature/SignatureProfileValidator.h>
41 #include <saml/util/SAMLConstants.h>
42 #include <xmltooling/logging.h>
43 #include <xmltooling/XMLToolingConfig.h>
44 #include <xmltooling/security/SignatureTrustEngine.h>
45 #include <xmltooling/signature/Signature.h>
46 #include <xmltooling/signature/SignatureValidator.h>
47 #include <xmltooling/util/XMLHelper.h>
50 #include <xercesc/framework/LocalFileInputSource.hpp>
51 #include <xercesc/framework/URLInputSource.hpp>
52 #include <xercesc/framework/StdInInputSource.hpp>
53 #include <xercesc/framework/Wrapper4InputSource.hpp>
55 using namespace xmlsignature;
56 using namespace xmlconstants;
57 using namespace xmltooling::logging;
58 using namespace xmltooling;
59 using namespace samlconstants;
60 using namespace opensaml::saml2md;
61 using namespace opensaml;
62 using namespace xercesc;
65 template<class T> T* buildPlugin(const char* path, PluginManager<T,string,const DOMElement*>& mgr)
68 DOMDocument* doc=XMLToolingConfig::getConfig().getParser().parse(in);
69 XercesJanitor<DOMDocument> janitor(doc);
71 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
72 auto_ptr_char type(doc->getDocumentElement()->getAttributeNS(NULL,_type));
73 if (type.get() && *type.get())
74 return mgr.newPlugin(type.get(), doc->getDocumentElement());
75 throw XMLToolingException("Missing type in plugin configuration.");
78 CredentialResolver* buildSimpleResolver(const char* key, const char* cert)
80 static const XMLCh _CredentialResolver[] = UNICODE_LITERAL_18(C,r,e,d,e,n,t,i,a,l,R,e,s,o,l,v,e,r);
81 static const XMLCh _certificate[] = UNICODE_LITERAL_11(c,e,r,t,i,f,i,c,a,t,e);
82 static const XMLCh _key[] = UNICODE_LITERAL_3(k,e,y);
84 DOMDocument* doc = XMLToolingConfig::getConfig().getParser().newDocument();
85 XercesJanitor<DOMDocument> janitor(doc);
86 DOMElement* root = doc->createElementNS(NULL, _CredentialResolver);
88 auto_ptr_XMLCh widenit(key);
89 root->setAttributeNS(NULL, _key, widenit.get());
92 auto_ptr_XMLCh widenit(cert);
93 root->setAttributeNS(NULL, _certificate, widenit.get());
96 return XMLToolingConfig::getConfig().CredentialResolverManager.newPlugin(FILESYSTEM_CREDENTIAL_RESOLVER, root);
99 class DummyCredentialResolver : public CredentialResolver
102 DummyCredentialResolver() {}
103 ~DummyCredentialResolver() {}
105 Lockable* lock() {return this;}
108 const Credential* resolve(const CredentialCriteria* criteria=NULL) const {return NULL;}
109 vector<const Credential*>::size_type resolve(
110 vector<const Credential*>& results, const CredentialCriteria* criteria=NULL
114 int main(int argc,char* argv[])
117 char* url_param=NULL;
118 char* path_param=NULL;
119 char* key_param=NULL;
120 char* cert_param=NULL;
125 // metadata lookup options
129 const XMLCh* protocol = NULL;
133 for (int i=1; i<argc; i++) {
134 if (!strcmp(argv[i],"-u") && i+1<argc)
136 else if (!strcmp(argv[i],"-f") && i+1<argc)
137 path_param=argv[++i];
138 else if (!strcmp(argv[i],"-id") && i+1<argc)
140 else if (!strcmp(argv[i],"-s"))
142 else if (!strcmp(argv[i],"-k") && i+1<argc)
144 else if (!strcmp(argv[i],"-c") && i+1<argc)
145 cert_param=argv[++i];
146 else if (!strcmp(argv[i],"-R") && i+1<argc)
148 else if (!strcmp(argv[i],"-T") && i+1<argc)
150 else if (!strcmp(argv[i],"-M") && i+1<argc)
152 else if (!strcmp(argv[i],"-i") && i+1<argc)
154 else if (!strcmp(argv[i],"-p") && i+1<argc)
156 else if (!strcmp(argv[i],"-r") && i+1<argc)
158 else if (!strcmp(argv[i],"-ns") && i+1<argc)
160 else if (!strcmp(argv[i],"-saml10"))
161 protocol=samlconstants::SAML10_PROTOCOL_ENUM;
162 else if (!strcmp(argv[i],"-saml11"))
163 protocol=samlconstants::SAML11_PROTOCOL_ENUM;
164 else if (!strcmp(argv[i],"-saml2"))
165 protocol=samlconstants::SAML20P_NS;
166 else if (!strcmp(argv[i],"-idp"))
167 rname="IDPSSODescriptor";
168 else if (!strcmp(argv[i],"-aa"))
169 rname="AttributeAuthorityDescriptor";
170 else if (!strcmp(argv[i],"-pdp"))
171 rname="PDPDescriptor";
172 else if (!strcmp(argv[i],"-sp"))
173 rname="SPSSODescriptor";
176 if (verify && !cert_param && !cr_param && !t_param) {
177 cerr << "either -c or -R or -T option required when verifiying, see documentation for usage" << endl;
180 else if (!verify && !key_param && !cr_param) {
181 cerr << "either -k or -R option required when signing, see documentation for usage" << endl;
185 XMLToolingConfig& xmlconf = XMLToolingConfig::getConfig();
186 xmlconf.log_config();
187 SAMLConfig& conf=SAMLConfig::getConfig();
190 Category& log = Category::getInstance("OpenSAML.Utility.SAMLSign");
195 // Parse the specified document.
196 static XMLCh base[]={chLatin_f, chLatin_i, chLatin_l, chLatin_e, chColon, chForwardSlash, chForwardSlash, chForwardSlash, chNull};
197 DOMDocument* doc=NULL;
199 URLInputSource src(base,url_param);
200 Wrapper4InputSource dsrc(&src,false);
201 doc=xmlconf.getParser().parse(dsrc);
203 else if (path_param) {
204 auto_ptr_XMLCh widenit(path_param);
205 LocalFileInputSource src(base,widenit.get());
206 Wrapper4InputSource dsrc(&src,false);
207 doc=xmlconf.getParser().parse(dsrc);
210 StdInInputSource src;
211 Wrapper4InputSource dsrc(&src,false);
212 doc=xmlconf.getParser().parse(dsrc);
216 XercesJanitor<DOMDocument> jan(doc);
217 auto_ptr<XMLObject> sourcewrapper(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
220 // Navigate to the selected node, or use the root if no ID specified.
221 // Then make sure it's a SignableSAMLObject.
222 XMLObject* source = sourcewrapper.get();
224 auto_ptr_XMLCh widenit(id_param);
225 source = XMLHelper::getXMLObjectById(*source, widenit.get());
227 throw XMLToolingException("Element with ID ($1) not found.", params(1,id_param));
229 SignableObject* signable = dynamic_cast<SignableObject*>(source);
231 throw XMLToolingException("Input is not a signable SAML object.");
234 if (!signable->getSignature())
235 throw SignatureException("Cannot verify unsigned object.");
237 // Check the profile.
238 SignatureProfileValidator sigval;
239 sigval.validate(signable->getSignature());
241 if (cert_param || cr_param) {
242 // Build a resolver to supply trusted credentials.
243 auto_ptr<CredentialResolver> cr(
244 cr_param ? buildPlugin(cr_param, xmlconf.CredentialResolverManager) : buildSimpleResolver(NULL, cert_param)
246 Locker locker(cr.get());
249 CredentialCriteria cc;
250 cc.setUsage(Credential::SIGNING_CREDENTIAL);
251 cc.setSignature(*(signable->getSignature()), CredentialCriteria::KEYINFO_EXTRACTION_KEY);
253 cc.setPeerName(issuer);
255 // Try every credential we can find.
256 vector<const Credential*> creds;
257 if (cr->resolve(creds, &cc)) {
259 SignatureValidator sigValidator;
260 for (vector<const Credential*>::const_iterator i = creds.begin(); i != creds.end(); ++i) {
262 sigValidator.setCredential(*i);
263 sigValidator.validate(signable->getSignature());
264 log.info("successful signature verification");
268 catch (exception& e) {
269 log.info("error trying verification key: %s", e.what());
273 throw SignatureException("CredentialResolver did not supply a successful verification key.");
276 throw SignatureException("CredentialResolver did not supply any verification keys.");
280 // TrustEngine-based verification, so try and build the plugins.
281 auto_ptr<TrustEngine> trust(buildPlugin(t_param, xmlconf.TrustEngineManager));
282 SignatureTrustEngine* sigtrust = dynamic_cast<SignatureTrustEngine*>(trust.get());
283 if (m_param && rname && issuer) {
286 protocol = XMLString::transcode(prot);
290 cerr << "use of metadata option requires a protocol option" << endl;
293 auto_ptr<MetadataProvider> metadata(buildPlugin(m_param, conf.MetadataProviderManager));
296 const XMLCh* ns = rns ? XMLString::transcode(rns) : samlconstants::SAML20MD_NS;
297 auto_ptr_XMLCh n(rname);
298 QName q(ns, n.get());
300 Locker locker(metadata.get());
301 MetadataProvider::Criteria mc(issuer, &q, protocol);
302 pair<const EntityDescriptor*,const RoleDescriptor*> entity = metadata->getEntityDescriptor(mc);
304 throw MetadataException("no metadata found for ($1)", params(1, issuer));
305 else if (!entity.second)
306 throw MetadataException("compatible role $1 not found for ($2)", params(2, q.toString().c_str(), issuer));
308 MetadataCredentialCriteria mcc(*entity.second);
309 if (sigtrust->validate(*signable->getSignature(), *metadata.get(), &mcc))
310 log.info("successful signature verification");
312 throw SignatureException("Unable to verify signature with TrustEngine and supplied metadata.");
316 CredentialCriteria cc;
317 cc.setUsage(Credential::SIGNING_CREDENTIAL);
318 cc.setSignature(*(signable->getSignature()), CredentialCriteria::KEYINFO_EXTRACTION_KEY);
320 cc.setPeerName(issuer);
321 DummyCredentialResolver dummy;
322 if (sigtrust->validate(*signable->getSignature(), dummy, &cc))
323 log.info("successful signature verification");
325 throw SignatureException("Unable to verify signature with TrustEngine (no metadata supplied).");
330 // Build a resolver to supply a credential.
331 auto_ptr<CredentialResolver> cr(
332 cr_param ? buildPlugin(cr_param, xmlconf.CredentialResolverManager) : buildSimpleResolver(key_param, cert_param)
334 Locker locker(cr.get());
335 CredentialCriteria cc;
336 cc.setUsage(Credential::SIGNING_CREDENTIAL);
337 const Credential* cred = cr->resolve(&cc);
339 throw XMLSecurityException("Unable to resolve a signing credential.");
341 // Attach new signature.
342 Signature* sig = SignatureBuilder::buildSignature();
343 signable->setSignature(sig);
345 // Sign response while re-marshalling.
346 vector<Signature*> sigs(1,sig);
347 XMLHelper::serialize(signable->marshall((DOMDocument*)NULL,&sigs,cred), cout);
350 catch(exception& e) {
351 log.errorStream() << "caught an exception: " << e.what() << logging::eol;