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
|
<?php
/**
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.|
* o The names of the authors may not be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @author Richard Heyes <richard@php.net>
*/
namespace Fabiang\Sasl;
use Fabiang\Sasl\Exception\InvalidArgumentException;
/**
* Client implementation of various SASL mechanisms
*
* @author Richard Heyes <richard@php.net>
*/
class Sasl
{
/**
* Known authentication mechanisms classes.
*
* @var array
*/
protected $mechanisms = array(
'anonymous' => 'Fabiang\\Sasl\Authentication\\Anonymous',
'login' => 'Fabiang\\Sasl\Authentication\\Login',
'plain' => 'Fabiang\\Sasl\Authentication\\Plain',
'external' => 'Fabiang\\Sasl\Authentication\\External',
'crammd5' => 'Fabiang\\Sasl\Authentication\\CramMD5',
'digestmd5' => 'Fabiang\\Sasl\Authentication\\DigestMD5',
);
/**
* Factory class. Returns an object of the request
* type.
*
* @param string $type One of: Anonymous
* Plain
* CramMD5
* DigestMD5
* SCRAM-* (any mechanism of the SCRAM family)
* Types are not case sensitive
* @param Options|array Options for authentication
* @return Authentication\AuthenticationInterface
*/
public function factory($type, $options = array())
{
$className = null;
$parameter = null;
$matches = array();
$options = $this->createOptionsObject($options);
$formatedType = strtolower(str_replace('-', '', $type));
if (isset($this->mechanisms[$formatedType])) {
$className = $this->mechanisms[$formatedType];
} elseif (preg_match('/^scram(?<algo>.{1,9})$/i', $formatedType, $matches)) {
$className = 'Fabiang\\Sasl\Authentication\\SCRAM';
$parameter = $matches['algo'];
}
if (null === $className) {
throw new InvalidArgumentException("Invalid SASL mechanism type '$type'");
}
$object = new $className($options, $parameter);
return $object;
}
/**
*
* @param Options|array $options
* @return \Fabiang\Sasl\Options
* @throws InvalidArgumentException
*/
private function createOptionsObject($options)
{
$optionsObject = $options;
if (is_array($options)) {
$optionsObject = new Options(
$this->checkEmpty($options, 'authcid'),
$this->checkEmpty($options, 'secret'),
$this->checkEmpty($options, 'authzid'),
$this->checkEmpty($options, 'service'),
$this->checkEmpty($options, 'hostname')
);
}
if (!($optionsObject instanceof Options)) {
throw new InvalidArgumentException(
'Invalid options passed. Argument must be either of type "Fabiang\Sasl\Options" or "array", "'
. (is_object($options) ? get_class($options) : gettype($options))
. '" given.'
);
}
return $optionsObject;
}
/**
*
* @param array $array
* @param string $key
* @return mixed
*/
private function checkEmpty(array $array, $key)
{
if (!empty($array[$key])) {
return $array[$key];
}
return null;
}
}
|
