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
|
<?php
/*
** Copyright (C) 2001-2025 Zabbix SIA
**
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
**
** This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
** without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
** See the GNU Affero General Public License for more details.
**
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
**/
/**
* A parser for AD samAccountName or userPrincipalName parser.
*/
class CADNameAttributeParser extends CParser {
const ZBX_TYPE_UNKNOWN = 0;
const ZBX_TYPE_SAMA = 0x1;
const ZBX_TYPE_UPN = 0x2;
/**
* User name attribute type.
*
* @var int
*/
private $name_type;
/**
* @var string
*/
private $user_name;
/**
* @var string
*/
private $domain_name;
/**
* @var array
*/
private $options;
/**
* Create instance of parser.
*
* @param array $options Array of options.
* @param int $options['strict'] For sAMAccount name check length of parsed domain and user. Default false.
* @param int $options['nametype'] Bit mask what type of user name should be parsed.
* Default parse sAMAccountName and UserPrincipalName.
*/
public function __construct(array $options = []) {
$options += ['nametype' => self::ZBX_TYPE_SAMA | self::ZBX_TYPE_UPN];
$this->options = [
'strict' => array_key_exists('strict', $options) && (bool) $options['strict'],
'type_sama' => array_key_exists('nametype', $options) && ($options['nametype'] & self::ZBX_TYPE_SAMA),
'type_upn' => array_key_exists('nametype', $options) && ($options['nametype'] & self::ZBX_TYPE_UPN)
];
}
/**
* Parse given name attribute value.
*
* @param string $source Source string that needs to be parsed.
* @param int $pos Position offset.
*
* @return int
*/
public function parse($source, $pos = 0) {
$this->length = 0;
$this->user_name = '';
$this->domain_name = '';
$this->match = '';
$this->name_type = self::ZBX_TYPE_UNKNOWN;
if (($this->options['type_upn']) && $this->parseUserPrincipalName($source, $pos) == self::PARSE_SUCCESS) {
$this->name_type = self::ZBX_TYPE_UPN;
}
elseif ($this->options['type_sama'] && $this->parseSamAccountName($source, $pos) == self::PARSE_SUCCESS) {
$this->name_type = self::ZBX_TYPE_SAMA;
}
else {
return self::PARSE_FAIL;
}
return isset($source[$pos]) ? self::PARSE_SUCCESS_CONT : self::PARSE_SUCCESS;
}
/**
* Get parsed name attribute type.
*
* @return int
*/
public function getNameType() {
return $this->name_type;
}
/**
* Get parsed user name value.
*
* @return string|null
*/
public function getUserName() {
return ($this->name_type == self::ZBX_TYPE_UNKNOWN) ? null : $this->user_name;
}
/**
* Get parsed user domain name value.
*
* @return string|null
*/
public function getDomainName() {
return ($this->name_type == self::ZBX_TYPE_UNKNOWN) ? null : $this->domain_name;
}
/**
* Parse string searching for samAccountName.
* https://docs.microsoft.com/en-us/windows/desktop/ADSchema/a-samaccountname
* https://social.technet.microsoft.com/wiki/contents/articles/11216.active-directory-requirements-for-creating-objects.aspx
*
* @param string $source Source string that needs to be parsed.
* @param int $pos Position offset.
*
* @return int
*/
private function parseSamAccountName($source, &$pos) {
$strict = $this->options['strict'];
$regex = '/^(?<domain>[^\\\\\/\:\*\?\"\<\>]'.
($strict ? '{1,15}' : '+').
')\\\(?<user>[^\\\\\/\:\*\?\"\<\>@]'.
($strict ? '{1,20}' : '+').
')/i';
if (preg_match($regex, substr($source, $pos), $matches)) {
$this->length = strlen($matches[0]);
}
else {
return self::PARSE_FAIL;
}
$this->match = $matches[0];
$this->domain_name = $matches['domain'];
$this->user_name = $matches['user'];
$pos += $this->length;
return self::PARSE_SUCCESS;
}
/**
* Parse string searching for UserPrincipalName.
* https://docs.microsoft.com/en-us/windows/desktop/ADSchema/a-userprincipalname
*
* @param string $source Source string that needs to be parsed.
* @param int $pos Position offset.
*
* @return int
*/
private function parseUserPrincipalName($source, &$pos) {
$regex = '/^(?<user>[_a-z0-9-@]+(\.[_a-z0-9-]+)*)@(?<domain>[a-z0-9-]+(\.[a-z0-9-]+)*)/i';
if (preg_match($regex, substr($source, $pos), $matches)) {
$this->length = strlen($matches[0]);
}
else {
return self::PARSE_FAIL;
}
$this->match = $matches[0];
$this->domain_name = $matches['domain'];
$this->user_name = $matches['user'];
$pos += $this->length;
return self::PARSE_SUCCESS;
}
}
|
