File: AttributeAlter.php

package info (click to toggle)
simplesamlphp 1.13.1-2%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 11,304 kB
  • sloc: php: 65,124; xml: 629; python: 376; sh: 193; perl: 185; makefile: 43
file content (183 lines) | stat: -rw-r--r-- 5,529 bytes parent folder | download | duplicates (2)
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
<?php
/**
 * Filter to modify attributes using regular expressions
 *
 * This filter can modify or replace attributes given a regular expression.
 *
 * @author Jacob Christiansen, WAYF
 * @package simpleSAMLphp
 */
class sspmod_core_Auth_Process_AttributeAlter extends SimpleSAML_Auth_ProcessingFilter {

	/**
	 * Should the pattern found be replaced?
	 */
	private $replace = FALSE;

    /**
     * Should the value found be removed?
     */
    private $remove = FALSE;

    /**
	 * Pattern to search for.
	 */
	private $pattern = '';
	
	/**
	 * String to replace the pattern found with.
	 */
	private $replacement = FALSE;
	
	/**
	 * Attribute to search in
	 */
	private $subject = '';

	/**
	 * Attribute to place the result in.
	 */
	private $target = '';
	
	/**
	 * Initialize this filter.
	 *
	 * @param array $config  Configuration information about this filter.
	 * @param mixed $reserved  For future use.
     * @throws SimpleSAML_Error_Exception In case of invalid configuration.
	 */
	public function __construct($config, $reserved) {
		parent::__construct($config, $reserved);

        assert('is_array($config)');

		// parse filter configuration
		foreach ($config as $name => $value) {
			if (is_int($name)) {
                // check if this is an option
				if($value === '%replace') {
					$this->replace = TRUE;
				} elseif ($value == '%remove') {
					$this->remove = TRUE;
				} else {
					throw new SimpleSAML_Error_Exception('Unknown flag : ' . var_export($value, TRUE));
				}
				continue;
			}
			
			// Unknown flag
			if (!is_string($name)) {
				throw new SimpleSAML_Error_Exception('Unknown flag : ' . var_export($name, TRUE));
			}
			
			// Set pattern
			if ($name === 'pattern') {
				$this->pattern = $value;
			}
			
			// Set replacement
			if ($name === 'replacement') {
				$this->replacement = $value;
			}
			
			// Set subject
			if ($name === 'subject') {
				$this->subject = $value;
			}
			
			// Set target
			if ($name === 'target') {
				$this->target = $value;
			}
		}
	}

	/**
	 * Apply the filter to modify attributes.
	 *
	 * Modify existing attributes with the configured values.
	 *
	 * @param array &$request The current request.
     * @throws SimpleSAML_Error_Exception In case of invalid configuration.
	 */
	public function process(&$request) {
		assert('is_array($request)');
		assert('array_key_exists("Attributes", $request)');

		// get attributes from request
		$attributes =& $request['Attributes'];

		// check that all required params are set in config
		if (empty($this->pattern) || empty($this->subject)) {
			throw new SimpleSAML_Error_Exception("Not all params set in config.");
		}

		if (!$this->replace && !$this->remove && $this->replacement === false) {
			throw new SimpleSAML_Error_Exception("'replacement' must be set if neither '%replace' nor ".
                "'%remove' are set.");
		}

        if (!$this->replace && $this->replacement === null) {
            throw new SimpleSAML_Error_Exception("'%replace' must be set if 'replacement' is null.");
        }

        if ($this->replace && $this->remove) {
            throw new SimpleSAML_Error_Exception("'%replace' and '%remove' cannot be used together.");
        }

		if (empty($this->target)) {
            // use subject as target if target is not set
			$this->target = $this->subject;		
		}

        if ($this->subject !== $this->target && $this->remove) {
            throw new SimpleSAML_Error_Exception("Cannot use '%remove' when 'target' is different than 'subject'.");
        }

		if (!array_key_exists($this->subject, $attributes)) {
            // if no such subject, stop gracefully
            return;
        }

        if ($this->replace) { // replace the whole value
            foreach ($attributes[$this->subject] as &$value) {
                $matches = array();
                if (preg_match($this->pattern, $value, $matches) > 0) {
                    $new_value = $matches[0];

                    if ($this->replacement !== FALSE) {
                        $new_value = $this->replacement;
                    }

                    if ($this->subject === $this->target) {
                        $value = $new_value;
                    } else {
                        $attributes[$this->target][] = $new_value;
                    }
                }
            }
        } elseif ($this->remove) { // remove the whole value
            $removedAttrs = array();
            foreach ($attributes[$this->subject] as $value) {
                $matches = array();
                if (preg_match($this->pattern, $value, $matches) > 0) {
                    $removedAttrs[] = $value;
                }
            }
            $attributes[$this->target] = array_diff($attributes[$this->subject], $removedAttrs);

            if (empty($attributes[$this->target])) {
                unset($attributes[$this->target]);
            }
        } else { // replace only the part that matches
            if ($this->subject === $this->target) {
                $attributes[$this->target] = preg_replace($this->pattern, $this->replacement,
                                                          $attributes[$this->subject]);
            } else {
                $attributes[$this->target] = array_diff(preg_replace($this->pattern, $this->replacement,
                                                                     $attributes[$this->subject]),
                                                        $attributes[$this->subject]);
            }
        }
	}
}