runff 1.0 commit

2019-04-29 16:09:00 +02:00
commit f1567f989b
1268 changed files with 98652 additions and 0 deletions
--- a/lib/SimpleSAML/Utils/Attributes.php
+++ b/lib/SimpleSAML/Utils/Attributes.php
@@ -0,0 +1,131 @@
+<?php
+namespace SimpleSAML\Utils;
+
+/**
+ * Attribute-related utility methods.
+ *
+ * @author Jaime Perez, UNINETT AS <jaime.perez@uninett.no>
+ * @package SimpleSAML
+ */
+class Attributes
+{
+
+    /**
+     * Look for an attribute in a normalized attributes array, failing if it's not there.
+     *
+     * @param array $attributes The normalized array containing attributes.
+     * @param string $expected The name of the attribute we are looking for.
+     * @param bool $allow_multiple Whether to allow multiple values in the attribute or not.
+     *
+     * @return mixed The value of the attribute we are expecting. If the attribute has multiple values and
+     * $allow_multiple is set to true, the first value will be returned.
+     *
+     * @throws \InvalidArgumentException If $attributes is not an array or $expected is not a string.
+     * @throws \SimpleSAML_Error_Exception If the expected attribute was not found in the attributes array.
+     */
+    public static function getExpectedAttribute($attributes, $expected, $allow_multiple = false)
+    {
+        if (!is_array($attributes)) {
+            throw new \InvalidArgumentException(
+                'The attributes array is not an array, it is: '.print_r($attributes, true).'.'
+            );
+        }
+
+        if (!is_string($expected)) {
+            throw new \InvalidArgumentException(
+                'The expected attribute is not a string, it is: '.print_r($expected, true).'.'
+            );
+        }
+
+        if (!array_key_exists($expected, $attributes)) {
+            throw new \SimpleSAML_Error_Exception("No such attribute '".$expected."' found.");
+        }
+        $attribute = $attributes[$expected];
+
+        if (!is_array($attribute)) {
+            throw new \InvalidArgumentException('The attributes array is not normalized, values should be arrays.');
+        }
+
+        if (count($attribute) === 0) {
+            throw new \SimpleSAML_Error_Exception("Empty attribute '".$expected."'.'");
+        } elseif (count($attribute) > 1) {
+            if ($allow_multiple === false) {
+                throw new \SimpleSAML_Error_Exception(
+                    'More than one value found for the attribute, multiple values not allowed.'
+                );
+            }
+        }
+        return reset($attribute);
+    }
+
+
+    /**
+     * Validate and normalize an array with attributes.
+     *
+     * This function takes in an associative array with attributes, and parses and validates
+     * this array. On success, it will return a normalized array, where each attribute name
+     * is an index to an array of one or more strings. On failure an exception will be thrown.
+     * This exception will contain an message describing what is wrong.
+     *
+     * @param array $attributes The array containing attributes that we should validate and normalize.
+     *
+     * @return array The normalized attributes array.
+     * @throws \InvalidArgumentException If input is not an array, array keys are not strings or attribute values are
+     *     not strings.
+     *
+     * @author Olav Morken, UNINETT AS <olav.morken@uninett.no>
+     * @author Jaime Perez, UNINETT AS <jaime.perez@uninett.no>
+     */
+    public static function normalizeAttributesArray($attributes)
+    {
+        if (!is_array($attributes)) {
+            throw new \InvalidArgumentException(
+                'The attributes array is not an array, it is: '.print_r($attributes, true).'".'
+            );
+        }
+
+        $newAttrs = array();
+        foreach ($attributes as $name => $values) {
+            if (!is_string($name)) {
+                throw new \InvalidArgumentException('Invalid attribute name: "'.print_r($name, true).'".');
+            }
+
+            $values = Arrays::arrayize($values);
+
+            foreach ($values as $value) {
+                if (!is_string($value)) {
+                    throw new \InvalidArgumentException(
+                        'Invalid attribute value for attribute '.$name.': "'.print_r($value, true).'".'
+                    );
+                }
+            }
+
+            $newAttrs[$name] = $values;
+        }
+
+        return $newAttrs;
+    }
+
+
+    /**
+     * Extract an attribute's namespace, or revert to default.
+     *
+     * This function takes in a namespaced attribute name and splits it in a namespace/attribute name tuple.
+     * When no namespace is found in the attribute name, it will be namespaced with the default namespace.
+     * This default namespace can be overriden by supplying a second parameter to this function.
+     *
+     * @param string $name The namespaced attribute name.
+     * @param string $defaultns The default namespace that should be used when no namespace is found.
+     *
+     * @return array The attribute name, split to the namespace and the actual attribute name.
+     */
+    public static function getAttributeNamespace($name, $defaultns)
+    {
+        $slash = strrpos($name, '/');
+        if ($slash !== false) {
+            $defaultns = substr($name, 0, $slash);
+            $name = substr($name, $slash + 1);
+        }
+        return array(htmlspecialchars($defaultns), htmlspecialchars($name));
+    }
+}