[cpp-opensaml] branch master updated: Removal of more deprecated methods.

Scott Cantor cantor.2 at osu.edu
Fri Apr 27 12:49:26 EDT 2018


This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch master
in repository cpp-opensaml.

View the commit online:
http://git.shibboleth.net/view/?p=cpp-opensaml.git;a=commit;h=7f0187c4eef91c50a0838d08eed12f9b23009141

The following commit(s) were added to refs/heads/master by this push:
       new  7f0187c   Removal of more deprecated methods.
7f0187c is described below

commit 7f0187c4eef91c50a0838d08eed12f9b23009141
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Fri Apr 27 12:49:20 2018 -0400

    Removal of more deprecated methods.
---
 saml/SAMLConfig.cpp                                |  5 ---
 saml/SAMLConfig.h                                  | 11 -----
 saml/internal.h                                    |  1 -
 saml/saml2/metadata/MetadataFilter.h               | 11 +----
 saml/saml2/metadata/MetadataProvider.h             | 12 ------
 .../impl/AbstractDynamicMetadataProvider.cpp       |  2 +-
 .../metadata/impl/BlacklistMetadataFilter.cpp      |  4 +-
 .../metadata/impl/DiscoverableMetadataProvider.cpp |  2 +-
 .../impl/EntityAttributesMetadataFilter.cpp        |  4 +-
 .../metadata/impl/EntityRoleMetadataFilter.cpp     |  4 +-
 saml/saml2/metadata/impl/MetadataProvider.cpp      | 49 +++++-----------------
 .../impl/RequireValidUntilMetadataFilter.cpp       |  4 +-
 .../metadata/impl/SignatureMetadataFilter.cpp      | 16 +++----
 .../metadata/impl/WhitelistMetadataFilter.cpp      |  4 +-
 14 files changed, 29 insertions(+), 100 deletions(-)

diff --git a/saml/SAMLConfig.cpp b/saml/SAMLConfig.cpp
index fdf3b9b..3f9437d 100644
--- a/saml/SAMLConfig.cpp
+++ b/saml/SAMLConfig.cpp
@@ -266,11 +266,6 @@ XMLCh* SAMLInternalConfig::generateIdentifier()
     return XMLString::transcode(hexform);
 }
 
-string SAMLInternalConfig::hashSHA1(const char* s, bool toHex)
-{
-    return SecurityHelper::doHash("SHA1", s, strlen(s), toHex);
-}
-
 void SAMLInternalConfig::setContactPriority(const XMLCh* contactTypes)
 {
     const XMLCh* ctype;
diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h
index cf52428..af66e1b 100644
--- a/saml/SAMLConfig.h
+++ b/saml/SAMLConfig.h
@@ -141,17 +141,6 @@ namespace opensaml {
         virtual XMLCh* generateIdentifier()=0;
         
         /**
-         * @deprecated
-         * Generate the SHA-1 hash of a string
-         * 
-         * @param s     NULL-terminated string to hash
-         * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes
-         *  
-         * @return  SHA-1 hash of the data
-         */
-        virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
-
-        /**
          * Sets the order of contact types to use in annotating exceptions with contact information.
          *
          * @param contactTypes  whitespace-delimited list of contact types
diff --git a/saml/internal.h b/saml/internal.h
index a017016..1e43ce8 100644
--- a/saml/internal.h
+++ b/saml/internal.h
@@ -106,7 +106,6 @@ namespace opensaml {
         void generateRandomBytes(void* buf, unsigned int len);
         void generateRandomBytes(std::string& buf, unsigned int len);
         XMLCh* generateIdentifier();
-        std::string hashSHA1(const char* data, bool toHex=false);
         void setContactPriority(const XMLCh*);
         const saml2md::ContactPerson* getContactPerson(const saml2md::EntityDescriptor&) const;
         const saml2md::ContactPerson* getContactPerson(const saml2md::RoleDescriptor&) const;
diff --git a/saml/saml2/metadata/MetadataFilter.h b/saml/saml2/metadata/MetadataFilter.h
index a8f9316..10c47c0 100644
--- a/saml/saml2/metadata/MetadataFilter.h
+++ b/saml/saml2/metadata/MetadataFilter.h
@@ -100,22 +100,13 @@ namespace opensaml {
             virtual const char* getId() const=0;
 
             /**
-             * @Deprecated
-             * Filters the given metadata. Exceptions should generally not be thrown to
-             * signal the removal of information, only for systemic processing failure.
-             *
-             * @param xmlObject the metadata to be filtered
-             */
-            virtual void doFilter(xmltooling::XMLObject& xmlObject) const;
-
-            /**
              * Filters the given metadata. Exceptions should generally not be thrown to
              * signal the removal of information, only for systemic processing failure.
              *
              * @param ctx       context interface, or nullptr
              * @param xmlObject the metadata to be filtered
              */
-            virtual void doFilter(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const;
+            virtual void doFilter(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const=0;
         };
 
         /**
diff --git a/saml/saml2/metadata/MetadataProvider.h b/saml/saml2/metadata/MetadataProvider.h
index e860040..89b0eb5 100644
--- a/saml/saml2/metadata/MetadataProvider.h
+++ b/saml/saml2/metadata/MetadataProvider.h
@@ -261,18 +261,7 @@ namespace opensaml {
 
         protected:
             /**
-             * @Deprecated
              * Applies any installed filters to a metadata instance.
-             * This passes the statically provided context to the filter
-             * and so is equivalent to doFilters(m_filterContext, xmlObject)
-             *
-             * @param xmlObject the metadata to be filtered
-             */
-            void doFilters(xmltooling::XMLObject& xmlObject) const;
-
-            /**
-             * Applies any installed filters to a metadata instance.
-             * This must not be called if the static context has been set (via setContext).
              *
              * @param ctx The Context for this filtering operation.
              * @param xmlObject the metadata to be filtered
@@ -280,7 +269,6 @@ namespace opensaml {
             void doFilters(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const;
 
         private:
-            void doFiltersInternal(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const;
             const MetadataFilterContext* m_filterContext;
             boost::ptr_vector<MetadataFilter> m_filters;
         };
diff --git a/saml/saml2/metadata/impl/AbstractDynamicMetadataProvider.cpp b/saml/saml2/metadata/impl/AbstractDynamicMetadataProvider.cpp
index 384c18d..0eae4a6 100644
--- a/saml/saml2/metadata/impl/AbstractDynamicMetadataProvider.cpp
+++ b/saml/saml2/metadata/impl/AbstractDynamicMetadataProvider.cpp
@@ -304,7 +304,7 @@ pair<const EntityDescriptor*,const RoleDescriptor*> AbstractDynamicMetadataProvi
         }
 
         // Filter it, which may throw.
-        doFilters(*entity2);
+        doFilters(nullptr, *entity2);
 
         time_t now = time(nullptr);
         time_t cmp = now;
diff --git a/saml/saml2/metadata/impl/BlacklistMetadataFilter.cpp b/saml/saml2/metadata/impl/BlacklistMetadataFilter.cpp
index 7081e13..979f2b9 100644
--- a/saml/saml2/metadata/impl/BlacklistMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/BlacklistMetadataFilter.cpp
@@ -48,7 +48,7 @@ namespace opensaml {
             ~BlacklistMetadataFilter() {}
             
             const char* getId() const { return BLACKLIST_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
+            void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
             void filterGroup(EntitiesDescriptor*) const;
@@ -86,7 +86,7 @@ BlacklistMetadataFilter::BlacklistMetadataFilter(const DOMElement* e)
     }
 }
 
-void BlacklistMetadataFilter::doFilter(XMLObject& xmlObject) const
+void BlacklistMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
     EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
     if (group) {
diff --git a/saml/saml2/metadata/impl/DiscoverableMetadataProvider.cpp b/saml/saml2/metadata/impl/DiscoverableMetadataProvider.cpp
index 6876313..52c7a51 100644
--- a/saml/saml2/metadata/impl/DiscoverableMetadataProvider.cpp
+++ b/saml/saml2/metadata/impl/DiscoverableMetadataProvider.cpp
@@ -57,7 +57,7 @@ DiscoverableMetadataProvider::DiscoverableMetadataProvider(const DOMElement* e)
 
     const XMLCh* attrib = e? e->getAttributeNS(nullptr, legacyOrgNames) : nullptr;
     if (attrib && *attrib) {
-        Category::getInstance(SAML_LOGCAT ".MetadataProvider.Discoverable").warn("legacyOrgNames is a deprecated attribute for MetadataProviders");
+        Category::getInstance(SAML_LOGCAT ".MetadataProvider.Discoverable").warn("DEPRECATED: legacyOrgNames is a deprecated attribute for MetadataProviders");
     }
 
     m_legacyOrgNames = XMLHelper::getAttrBool(e, false, legacyOrgNames);
diff --git a/saml/saml2/metadata/impl/EntityAttributesMetadataFilter.cpp b/saml/saml2/metadata/impl/EntityAttributesMetadataFilter.cpp
index e9d0103..a1e7e77 100644
--- a/saml/saml2/metadata/impl/EntityAttributesMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/EntityAttributesMetadataFilter.cpp
@@ -53,7 +53,7 @@ namespace opensaml {
             ~EntityAttributesMetadataFilter() {}
 
             const char* getId() const { return ENTITYATTR_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
+            void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
             void filterEntity(EntityDescriptor* entity) const;
@@ -97,7 +97,7 @@ EntityAttributesMetadataFilter::EntityAttributesMetadataFilter(const DOMElement*
     }
 }
 
-void EntityAttributesMetadataFilter::doFilter(XMLObject& xmlObject) const
+void EntityAttributesMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
     EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
     if (group) {
diff --git a/saml/saml2/metadata/impl/EntityRoleMetadataFilter.cpp b/saml/saml2/metadata/impl/EntityRoleMetadataFilter.cpp
index ce725fb..1cc0717 100644
--- a/saml/saml2/metadata/impl/EntityRoleMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/EntityRoleMetadataFilter.cpp
@@ -47,7 +47,7 @@ namespace opensaml {
             ~EntityRoleMetadataFilter() {}
 
             const char* getId() const { return ENTITYROLE_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
+            void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
             void doFilter(EntityDescriptor& entity) const;
@@ -102,7 +102,7 @@ EntityRoleMetadataFilter::EntityRoleMetadataFilter(const DOMElement* e)
     }
 }
 
-void EntityRoleMetadataFilter::doFilter(XMLObject& xmlObject) const
+void EntityRoleMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
     EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
     if (group) {
diff --git a/saml/saml2/metadata/impl/MetadataProvider.cpp b/saml/saml2/metadata/impl/MetadataProvider.cpp
index 4b3a77a..41e9e41 100644
--- a/saml/saml2/metadata/impl/MetadataProvider.cpp
+++ b/saml/saml2/metadata/impl/MetadataProvider.cpp
@@ -92,7 +92,7 @@ static const XMLCh Exclude[] =          UNICODE_LITERAL_7(E,x,c,l,u,d,e);
 static const XMLCh Include[] =          UNICODE_LITERAL_7(I,n,c,l,u,d,e);
 static const XMLCh _type[] =            UNICODE_LITERAL_4(t,y,p,e);
 
-MetadataProvider::MetadataProvider() { throw MetadataException("Illegal constructor call");}
+MetadataProvider::MetadataProvider() { throw MetadataException("Illegal constructor call"); }
 
 MetadataProvider::MetadataProvider(const DOMElement* e) : m_filterContext(nullptr)
 {
@@ -100,7 +100,7 @@ MetadataProvider::MetadataProvider(const DOMElement* e) : m_filterContext(nullpt
     NDC ndc("MetadataProvider");
 #endif
     Category& log = Category::getInstance(SAML_LOGCAT ".MetadataProvider");
-    SAMLConfig& conf = SAMLConfig::getConfig();
+    const SAMLConfig& conf = SAMLConfig::getConfig();
 
     // Locate any default recognized filters and plugins.
     try {
@@ -119,34 +119,34 @@ MetadataProvider::MetadataProvider(const DOMElement* e) : m_filterContext(nullpt
                 }
             }
             else if (XMLString::equals(child->getLocalName(), SigFilter)) {
-                log.warn("<SignatureMetadataFilter> and will be deprecated in future versions: use type=\"%s\"", SIGNATURE_METADATA_FILTER);
+                log.warn("<SignatureMetadataFilter> will be deprecated in future versions: use type=\"%s\"", SIGNATURE_METADATA_FILTER);
                 log.info("building MetadataFilter of type %s", SIGNATURE_METADATA_FILTER);
                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(SIGNATURE_METADATA_FILTER, child));
             }
             else if (XMLString::equals(child->getLocalName(), Whitelist)) {
-                log.warn("<WhitelistMetadataFilter> and will be deprecated in future versions use: type=\"%s\"", WHITELIST_METADATA_FILTER);
+                log.warn("<WhitelistMetadataFilter> will be deprecated in future versions use: type=\"%s\"", WHITELIST_METADATA_FILTER);
                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, child));
             }
             else if (XMLString::equals(child->getLocalName(), Blacklist)) {
-                log.warn("<BlacklistMetadataFilter> and will be deprecated in future versions use: type=\"%s\"", BLACKLIST_METADATA_FILTER);
+                log.warn("<BlacklistMetadataFilter> will be deprecated in future versions use: type=\"%s\"", BLACKLIST_METADATA_FILTER);
                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, child));
             }
             else if (XMLString::equals(child->getLocalName(), Include)) {
-                log.warn("<Include> and will be deprecated in future versions: use type=\"%s\"", WHITELIST_METADATA_FILTER);
+                log.warn("<Include> will be deprecated in future versions: use type=\"%s\"", WHITELIST_METADATA_FILTER);
                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, e));
             }
             else if (XMLString::equals(child->getLocalName(), Exclude)) {
-                log.warn("<Exclude> and will be deprecated in future versions: use type=\"%s\"", BLACKLIST_METADATA_FILTER);
+                log.warn("<Exclude> will be deprecated in future versions: use type=\"%s\"", BLACKLIST_METADATA_FILTER);
                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, e));
             }
             child = XMLHelper::getNextSiblingElement(child);
         }
     }
-    catch (XMLToolingException& ex) {
+    catch (const XMLToolingException& ex) {
         log.error("caught exception while installing filters: %s", ex.what());
         throw;
     }
@@ -180,31 +180,15 @@ void MetadataProvider::setContext(const MetadataFilterContext* ctx)
     m_filterContext = ctx;
 }
 
-void MetadataProvider::doFiltersInternal(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
+void MetadataProvider::doFilters(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
-    Category& log = Category::getInstance(SAML_LOGCAT ".Metadata");
+    Category& log = Category::getInstance(SAML_LOGCAT ".MetadataProvider");
     for (ptr_vector<MetadataFilter>::const_iterator i = m_filters.begin(); i != m_filters.end(); i++) {
         log.info("applying metadata filter (%s)", i->getId());
-        i->doFilter(ctx, xmlObject);
+        i->doFilter(ctx ? ctx : m_filterContext, xmlObject);
     }
 }
 
-void MetadataProvider::doFilters(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
-{
-    if (m_filterContext) {
-        Category& log = Category::getInstance(SAML_LOGCAT ".Metadata");
-        log.crit("Internal error: calling MetadataProvider::doFilters with a static and dynamic context");
-        throw;
-    }
-    doFiltersInternal(ctx, xmlObject);
-}
-
-void MetadataProvider::doFilters(XMLObject& xmlObject) const
-{
-    doFiltersInternal(m_filterContext, xmlObject);
-}
-
-
 void MetadataProvider::outputStatus(ostream& os) const
 {
 }
@@ -258,17 +242,6 @@ MetadataFilter::~MetadataFilter()
 {
 }
 
-void MetadataFilter::doFilter(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const
-{
-    // Default call into deprecated method.
-    doFilter(xmlObject);
-}
-
-void MetadataFilter::doFilter(xmltooling::XMLObject& xmlObject) const
-{
-    // Empty default for deprecated method.
-}
-
 MetadataFilterContext::MetadataFilterContext()
 {
 }
diff --git a/saml/saml2/metadata/impl/RequireValidUntilMetadataFilter.cpp b/saml/saml2/metadata/impl/RequireValidUntilMetadataFilter.cpp
index 4781b14..a43fa00 100644
--- a/saml/saml2/metadata/impl/RequireValidUntilMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/RequireValidUntilMetadataFilter.cpp
@@ -46,7 +46,7 @@ namespace opensaml {
             ~RequireValidUntilMetadataFilter() {}
             
             const char* getId() const { return REQUIREVALIDUNTIL_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
+            void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
             time_t m_maxValidityInterval;
@@ -67,7 +67,7 @@ RequireValidUntilMetadataFilter::RequireValidUntilMetadataFilter(const DOMElemen
 {
 }
 
-void RequireValidUntilMetadataFilter::doFilter(XMLObject& xmlObject) const
+void RequireValidUntilMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
     const TimeBoundSAMLObject* tbo = dynamic_cast<const TimeBoundSAMLObject*>(&xmlObject);
     if (!tbo)
diff --git a/saml/saml2/metadata/impl/SignatureMetadataFilter.cpp b/saml/saml2/metadata/impl/SignatureMetadataFilter.cpp
index 9d83fbd..1e6a1b9 100644
--- a/saml/saml2/metadata/impl/SignatureMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/SignatureMetadataFilter.cpp
@@ -58,7 +58,6 @@ namespace opensaml {
             ~SignatureMetadataFilter() {}
 
             const char* getId() const { return SIGNATURE_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
             void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
@@ -135,20 +134,15 @@ SignatureMetadataFilter::SignatureMetadataFilter(const DOMElement* e)
 
 void SignatureMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
+#ifdef _DEBUG
+    NDC ndc("doFilter");
+#endif
+
     const BatchLoadMetadataFilterContext* bCtx = dynamic_cast<const BatchLoadMetadataFilterContext*>(ctx);
     if (!m_verifyBackup && bCtx && bCtx->isBackingFile()) {
         m_log.debug("Skipping SignatureMetadataFilter on load from backup");
+        return;
     }
-    else {
-        doFilter(xmlObject);
-    }
-}
-
-void SignatureMetadataFilter::doFilter(XMLObject& xmlObject) const
-{
-#ifdef _DEBUG
-    NDC ndc("doFilter");
-#endif
 
     try {
         EntitiesDescriptor& entities = dynamic_cast<EntitiesDescriptor&>(xmlObject);
diff --git a/saml/saml2/metadata/impl/WhitelistMetadataFilter.cpp b/saml/saml2/metadata/impl/WhitelistMetadataFilter.cpp
index dd98063..a0ec241 100644
--- a/saml/saml2/metadata/impl/WhitelistMetadataFilter.cpp
+++ b/saml/saml2/metadata/impl/WhitelistMetadataFilter.cpp
@@ -49,7 +49,7 @@ namespace opensaml {
             ~WhitelistMetadataFilter() {}
 
             const char* getId() const { return WHITELIST_METADATA_FILTER; }
-            void doFilter(XMLObject& xmlObject) const;
+            void doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const;
 
         private:
             void filterGroup(EntitiesDescriptor*) const;
@@ -87,7 +87,7 @@ WhitelistMetadataFilter::WhitelistMetadataFilter(const DOMElement* e)
     }
 }
 
-void WhitelistMetadataFilter::doFilter(XMLObject& xmlObject) const
+void WhitelistMetadataFilter::doFilter(const MetadataFilterContext* ctx, XMLObject& xmlObject) const
 {
     EntitiesDescriptor* group = dynamic_cast<EntitiesDescriptor*>(&xmlObject);
     if (group) {

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list