libsaml2-dev 2.5.3-2 / usr / include / saml / saml2 / metadata / DiscoverableMetadataProvider.h

This file is indexed.

/usr/include/saml/saml2/metadata/DiscoverableMetadataProvider.h is in libsaml2-dev 2.5.3-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/**
 * 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
 *
 * 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.
 */

/**
 * @file saml/saml2/metadata/DiscoverableMetadataProvider.h
 * 
 * A metadata provider that provides a JSON feed of IdP discovery information.
 */

#ifndef __saml2_discometadataprov_h__
#define __saml2_discometadataprov_h__

#include <saml/saml2/metadata/MetadataProvider.h>

#include <boost/shared_ptr.hpp>

namespace opensaml {
    
    namespace saml2 {
        class SAML_API Attribute;
    };

    namespace saml2md {

        class SAML_API EntityAttributes;
        class SAML_API EntityMatcher;
        
#if defined (_MSC_VER)
        #pragma warning( push )
        #pragma warning( disable : 4251 )
#endif
        /**
         * A metadata provider that provides a JSON feed of IdP discovery information.
         */
        class SAML_API DiscoverableMetadataProvider : public virtual MetadataProvider
        {
        protected:
            /**
             * Constructor.
             *
             * If a DOM is supplied, the following XML content is supported:
             *
             * <dl>
             *   <dt>legacyOrgNames</dt>
             *   <dd>true iff IdPs without a UIInfo extension should
             *      be identified using &lt;md:OrganizationDisplayName&gt;</dd>
             *   <dt>entityAttributes</dt>
             *   <dd>true iff tags found in &lt;mdattr:EntityAttributes&gt;
             *      extensions should be included in the feed</dd>
             *   <dt>&lt;DiscoveryFilter type="..." matcher="..." &gt;</dt>
             *   <dd>Zero or more filters of type "Whitelist" or "Blacklist" that
             *      affect which entities get exposed by the feed. The actual matching
             *      is driven by an EntityMatcher plugin identified by the matcher
             *      attribute. Other element content will be present to configure
             *      that plugin.</dd>
             * </dl>
             *
             * @param e DOM to supply configuration for provider
             */
            DiscoverableMetadataProvider(const xercesc::DOMElement* e=nullptr);
            
            /**
             * Generates a JSON feed of IdP discovery information for the current metadata.
             * <p>The provider <strong>MUST</strong> be write-locked.
             */
            virtual void generateFeed();

        public:
            virtual ~DiscoverableMetadataProvider();

            /**
             * Returns the ETag associated with the cached feed.
             * <p>The provider <strong>MUST</strong> be locked.
             *
             * @return the ETag value for the current feed state
             */
            virtual std::string getCacheTag() const;

            /**
             * Outputs the cached feed.
             * <p>The provider <strong>MUST</strong> be locked.
             *
             * @param os        stream to output feed into
             * @param first     on input, indicates if the feed is first in position,
             *                  on output will be false if the feed was non-empty
             * @param wrapArray true iff the feed array should be opened/closed by this provider
             */
            virtual void outputFeed(std::ostream& os, bool& first, bool wrapArray=true) const;

        protected:
            /** Storage for feed. */
            std::string m_feed;

            /** ETag for feed. */
            mutable std::string m_feedTag;

        private:
            void discoEntity(std::string& s, const EntityDescriptor* entity, bool& first) const;
            void discoGroup(std::string& s, const EntitiesDescriptor* group, bool& first) const;
            void discoEntityAttributes(std::string& s, const EntityAttributes& ea, bool& first) const;
            void discoAttributes(std::string& s, const std::vector<saml2::Attribute*>& attrs, bool& first) const;

            bool m_legacyOrgNames, m_entityAttributes;
            std::vector< std::pair< bool, boost::shared_ptr<EntityMatcher> > > m_discoFilters;
        };

#if defined (_MSC_VER)
        #pragma warning( pop )
#endif

    };
};

#endif /* __saml2_discometadataprov_h__ */

APT Browse - Built by Thomas Orozco.