/usr/include/shibsp/attribute/Attribute.h is in libshibsp-dev 2.5.2+dfsg-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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | /**
* 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 shibsp/attribute/Attribute.h
*
* A resolved attribute.
*/
#ifndef __shibsp_attribute_h__
#define __shibsp_attribute_h__
#include <shibsp/remoting/ddf.h>
#include <map>
#include <string>
#include <vector>
namespace shibsp {
#if defined (_MSC_VER)
#pragma warning( push )
#pragma warning( disable : 4251 )
#endif
/**
* A resolved attribute.
*
* <p>Resolved attributes are a neutral construct that represent both simple and
* complex attribute data structures that might be found in SAML assertions
* or obtained from other sources.
*
* <p>Attributes consist of an id/name that is locally unique (that is, unique to a
* configuration at any given point in time) and zero or more values. Values can
* be of any type or structure, but will generally be made available to applications
* only if a serialized string form exists. More complex values can be used with
* access control plugins and other components that understand them, however.
*/
class SHIBSP_API Attribute
{
MAKE_NONCOPYABLE(Attribute);
protected:
/**
* Constructor
*
* @param ids array with primary identifier in first position, followed by any aliases
*/
Attribute(const std::vector<std::string>& ids);
/**
* Constructs based on a remoted Attribute.
*
* <p>This allows Attribute objects to be recreated after marshalling.
* The DDF supplied must be a struct containing a single list member named
* with the Attribute's "id" and containing the values.
*
* @param in input object containing marshalled Attribute
*/
Attribute(DDF& in);
/**
* Maintains a copy of serialized attribute values, when possible.
*
* <p>Implementations should maintain the array when values are added or removed.
*/
mutable std::vector<std::string> m_serialized;
public:
virtual ~Attribute();
/**
* Returns the Attribute identifier.
*
* @return the Attribute identifier
*/
const char* getId() const;
/**
* Returns all of the effective names for the Attribute.
*
* @return immutable array of identifiers, with the primary ID in the first position
*/
const std::vector<std::string>& getAliases() const;
/**
* Returns all of the effective names for the Attribute.
*
* @return mutable array of identifiers, with the primary ID in the first position
*/
std::vector<std::string>& getAliases();
/**
* Sets whether case sensitivity should apply to basic value comparisons.
*
* @param caseSensitive true iff value comparisons should be case sensitive
*/
void setCaseSensitive(bool caseSensitive);
/**
* Sets whether the attribute should be exported for CGI use.
*
* @param internal true iff the attribute should <strong>NOT</strong> be exported
*/
void setInternal(bool internal);
/**
* Indicates whether case sensitivity should apply to basic value comparisons.
*
* @return true iff value comparisons should be case sensitive
*/
bool isCaseSensitive() const;
/**
* Indicates whether the attribute should be exported for CGI use.
*
* @return true iff the attribute should <strong>NOT</strong> be exported
*/
bool isInternal() const;
/**
* Returns the number of values.
*
* @return number of values
*/
virtual size_t valueCount() const;
/**
* Returns serialized Attribute values encoded as UTF-8 strings.
*
* @return an immutable vector of values
*/
virtual const std::vector<std::string>& getSerializedValues() const;
/**
* Informs the Attribute that values have changed and any serializations
* must be cleared.
*/
virtual void clearSerializedValues()=0;
/**
* Gets the string equivalent of the value at the specified position (starting from zero).
*
* @param index position of value
* @return the specified value in its "string" form, or nullptr if undefined
*/
virtual const char* getString(size_t index) const;
/**
* Gets the "scope" of the value at the specified position (starting from zero).
*
* @param index position of value
* @return the specified value's "scope", or nullptr if attribute is unscoped
*/
virtual const char* getScope(size_t index) const;
/**
* Removes the value at the specified position (starting from zero).
*
* @param index position of value to remove
*/
virtual void removeValue(size_t index);
/**
* Marshalls an Attribute for remoting.
*
* <p>This allows Attribute objects to be communicated across process boundaries
* without excess XML parsing. The DDF returned must be a struct containing
* a single list member named with the Attribute's "id". The name of the struct
* should contain the registered name of the Attribute implementation.
*/
virtual DDF marshall() const;
/**
* Unmarshalls a remoted Attribute.
*
* @param in remoted Attribute data
* @return a resolved Attribute of the proper subclass
*/
static Attribute* unmarshall(DDF& in);
/** A function that unmarshalls remoted data into the proper Attribute subclass. */
typedef Attribute* AttributeFactory(DDF& in);
/**
* Registers an AttributeFactory function for a given attribute "type".
*
* @param type string used at the root of remoted Attribute structures
* @param factory factory function
*/
static void registerFactory(const char* type, AttributeFactory* factory);
/**
* Deregisters an AttributeFactory function for a given attribute "type".
*
* @param type string used at the root of remoted Attribute structures
*/
static void deregisterFactory(const char* type);
/**
* Clears the map of factories.
*/
static void deregisterFactories();
private:
static std::map<std::string,AttributeFactory*> m_factoryMap;
std::vector<std::string> m_id;
bool m_caseSensitive,m_internal;
};
#if defined (_MSC_VER)
#pragma warning( pop )
#endif
/** Registers built-in Attribute types into the runtime. */
void registerAttributeFactories();
};
#endif /* __shibsp_attribute_h__ */
|