-/*
- * Copyright 2001-2009 Internet2
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
*/
/**
namespace xmltooling {
+ class XMLTOOL_API Mutex;
class XMLTOOL_API ParserPool;
class XMLTOOL_API PathResolver;
class XMLTOOL_API TemplateEngine;
#ifndef XMLTOOLING_NO_XMLSEC
class XMLTOOL_API CredentialResolver;
class XMLTOOL_API KeyInfoResolver;
+ class XMLTOOL_API PathValidator;
class XMLTOOL_API TrustEngine;
class XMLTOOL_API XSECCryptoX509CRL;
#endif
/**
* Singleton object that manages library startup/shutdown.configuration.
*
- * A locking interface is supplied as a convenience for code that wants to
+ * <p>A locking interface is supplied as a convenience for code that wants to
* obtain a global system lock, but the actual configuration itself is not
* synchronized.
*/
/**
* Shuts down library
- *
- * Each process using the library SHOULD call this function exactly once
+ * <p>Each process using the library SHOULD call this function exactly once
* before terminating itself
*/
virtual void term()=0;
/**
* Loads a shared/dynamic library extension.
- *
- * Extension libraries are managed using a pair of "C" linkage functions:<br>
+ *
+ * <p>Extension libraries are managed using a pair of "C" linkage functions:<br>
* extern "C" int xmltooling_extension_init(void* context);<br>
* extern "C" void xmltooling_extension_term();
- *
- * This method is internally synchronized.
+ *
+ * <p>This method is internally synchronized.
*
* @param path pathname of shared library to load into process
* @param context arbitrary data to pass to library initialization hook
* @return true iff library was loaded successfully
*/
- virtual bool load_library(const char* path, void* context=NULL)=0;
+ virtual bool load_library(const char* path, void* context=nullptr)=0;
/**
* Configure logging system.
- *
- * May be called first, before initializing the library. Other calls to it
+ * <p>May be called first, before initializing the library. Other calls to it
* must be externally synchronized.
*
* @param config either a logging configuration file, or a level from the set
* (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
* @return true iff configuration was successful
*/
- virtual bool log_config(const char* config=NULL)=0;
+ virtual bool log_config(const char* config=nullptr)=0;
/**
* Obtains a non-validating parser pool.
- * Library must be initialized first.
+ * <p>Library must be initialized first.
*
* @return reference to a non-validating parser pool.
*/
/**
* Obtains a validating parser pool.
- * Library must be initialized first. Schema/catalog registration must be
+ * <p>Library must be initialized first. Schema/catalog registration must be
* externally synchronized.
*
* @return reference to a validating parser pool.
*/
virtual ParserPool& getValidatingParser() const=0;
+ /**
+ * Returns a reference to a named mutex.
+ * <p>The first access to a given name will create the object.
+ *
+ * @param name name of mutex to access
+ * @return reference to a mutex object
+ */
+ virtual Mutex& getNamedMutex(const char* name)=0;
+
#ifndef XMLTOOLING_NO_XMLSEC
/**
* Returns the global KeyInfoResolver instance.
*
- * @return global KeyInfoResolver or NULL
+ * @return global KeyInfoResolver or nullptr
*/
const KeyInfoResolver* getKeyInfoResolver() const;
/**
* Returns the global ReplayCache instance.
*
- * @return global ReplayCache or NULL
+ * @return global ReplayCache or nullptr
*/
ReplayCache* getReplayCache() const;
/**
* Sets the global KeyInfoResolver instance.
- * This method must be externally synchronized with any code that uses the object.
+ * <p>This method must be externally synchronized with any code that uses the object.
* Any previously set object is destroyed.
*
* @param keyInfoResolver new KeyInfoResolver instance to store
/**
* Sets the global ReplayCache instance.
- * This method must be externally synchronized with any code that uses the object.
+ * <p>This method must be externally synchronized with any code that uses the object.
* Any previously set object is destroyed.
*
* @param replayCache new ReplayCache instance to store
/**
* Returns the global PathResolver instance.
*
- * @return global PathResolver or NULL
+ * @return global PathResolver or nullptr
*/
PathResolver* getPathResolver() const;
/**
* Returns the global TemplateEngine instance.
*
- * @return global TemplateEngine or NULL
+ * @return global TemplateEngine or nullptr
*/
TemplateEngine* getTemplateEngine() const;
/**
* Returns the global URLEncoder instance.
*
- * @return global URLEncoder or NULL
+ * @return global URLEncoder or nullptr
*/
const URLEncoder* getURLEncoder() const;
/**
* Sets the global PathResolver instance.
- * This method must be externally synchronized with any code that uses the object.
+ * <p>This method must be externally synchronized with any code that uses the object.
* Any previously set object is destroyed.
*
* @param pathResolver new PathResolver instance to store
/**
* Sets the global TemplateEngine instance.
- * This method must be externally synchronized with any code that uses the object.
+ * <p>This method must be externally synchronized with any code that uses the object.
* Any previously set object is destroyed.
*
* @param templateEngine new TemplateEngine instance to store
/**
* Sets the global URLEncoder instance.
- * This method must be externally synchronized with any code that uses the object.
+ * <p>This method must be externally synchronized with any code that uses the object.
* Any previously set object is destroyed.
*
* @param urlEncoder new URLEncoder instance to store
void setURLEncoder(URLEncoder* urlEncoder);
/**
+ * @deprecated
* List of catalog files to load into validating parser pool at initialization time.
- * Like other path settings, the separator depends on the platform
+ * <p>Like other path settings, the separator depends on the platform
* (semicolon on Windows, colon otherwise).
*/
std::string catalog_path;
-
+
+ /** A User-Agent header to include in HTTP client requests. */
+ std::string user_agent;
+
/**
* Adjusts any clock comparisons to be more liberal/permissive by the
* indicated number of seconds.
*/
unsigned int clock_skew_secs;
+#ifndef XMLTOOLING_LITE
+ /**
+ * Manages factories for StorageService plugins.
+ */
+ PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
+#endif
+
#ifndef XMLTOOLING_NO_XMLSEC
/**
* Returns an X.509 CRL implementation object.
virtual XSECCryptoX509CRL* X509CRL() const=0;
/**
+ * Manages factories for CredentialResolver plugins.
+ */
+ PluginManager<CredentialResolver,std::string,const xercesc::DOMElement*> CredentialResolverManager;
+
+ /**
* Manages factories for KeyInfoResolver plugins.
*/
PluginManager<KeyInfoResolver,std::string,const xercesc::DOMElement*> KeyInfoResolverManager;
/**
- * Manages factories for CredentialResolver plugins.
+ * Manages factories for PathValidator plugins.
*/
- PluginManager<CredentialResolver,std::string,const xercesc::DOMElement*> CredentialResolverManager;
+ PluginManager<PathValidator,std::string,const xercesc::DOMElement*> PathValidatorManager;
/**
* Manages factories for TrustEngine plugins.
PluginManager<TrustEngine,std::string,const xercesc::DOMElement*> TrustEngineManager;
/**
- * Manages factories for StorageService plugins.
- */
- PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
-
- /**
* Maps an XML Signature/Encryption algorithm identifier to a library-specific
* key algorithm and size for use in resolving credentials.
*
virtual std::pair<const char*,unsigned int> mapXMLAlgorithmToKeyAlgorithm(const XMLCh* xmlAlgorithm) const=0;
/**
+ * Types of XML Security algorithms.
+ */
+ enum XMLSecurityAlgorithmType {
+ ALGTYPE_UNK,
+ ALGTYPE_DIGEST,
+ ALGTYPE_SIGN,
+ ALGTYPE_ENCRYPT,
+ ALGTYPE_KEYENCRYPT,
+ ALGTYPE_KEYAGREE,
+ ALGTYPE_AUTHNENCRYPT
+ };
+
+ /**
* Registers an XML Signature/Encryption algorithm identifier against a library-specific
* key algorithm and size for use in resolving credentials.
*
* @param xmlAlgorithm XML Signature/Encryption algorithm identifier
* @param keyAlgorithm a key algorithm
* @param size a key size (or 0 if the size is irrelevant)
+ * @param type type of algorithm, if known
+ */
+ virtual void registerXMLAlgorithm(
+ const XMLCh* xmlAlgorithm, const char* keyAlgorithm, unsigned int size=0, XMLSecurityAlgorithmType type=ALGTYPE_UNK
+ )=0;
+
+ /**
+ * Checks for implementation support of a particular XML Security algorithm.
+ *
+ * @param xmlAlgorithm XML Signature/Encryption algorithm identifier
+ * @param type type of algorithm, or ALGTYPE_UNK to ignore
+ * @return true iff the algorithm is supported by the underlying libraries
*/
- virtual void registerXMLAlgorithm(const XMLCh* xmlAlgorithm, const char* keyAlgorithm, unsigned int size=0)=0;
+ virtual bool isXMLAlgorithmSupported(const XMLCh* xmlAlgorithm, XMLSecurityAlgorithmType type=ALGTYPE_UNK)=0;
#endif
/**
projects / shibboleth / cpp-xmltooling.git / blobdiff