-
Notifications
You must be signed in to change notification settings - Fork 1
/
DomainValidator.php
392 lines (347 loc) · 14.8 KB
/
DomainValidator.php
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php
namespace kdn\yii2\validators;
use Yii;
use yii\base\ErrorException;
use yii\base\InvalidConfigException;
use yii\validators\Validator;
/**
* Class DomainValidator.
* @package kdn\yii2\validators
*/
class DomainValidator extends Validator
{
/**
* @var bool whether to allow underscores in domain name;
* defaults to false
*/
public $allowUnderscore = false;
/**
* @var bool whether to allow the URL address along with domain name;
* defaults to true, meaning that validator should try to parse URL address and then validate domain name
*/
public $allowURL = true;
/**
* @var bool|callable whether to check whether domain name exists;
* be aware that this check can fail due to temporary DNS problems even if domain name exists;
* do not use it to check domain name availability;
* defaults to false;
* this field can be specified as a PHP callback, for example:
* ```php
* function (string $domain) {
* $records = @dns_get_record("$domain.", DNS_MX); // @ is just for simplicity of example, avoid using it
* if (empty($records)) {
* return ['Cannot find Mail Exchanger record for "{value}".', ['value' => $domain]];
* }
*
* return null; // the data is valid
* }
* ```
* note that alternatively you can override method `checkDNS`
* @see checkDNS
*/
public $checkDNS = false;
/**
* @var bool whether validation process should take into account IDN (internationalized domain names);
* defaults to false, meaning that validation of domain names containing IDN will always fail;
* note that in order to use IDN validation you have to install and enable `intl` PHP extension,
* otherwise an exception would be thrown
*/
public $enableIDN = false;
/**
* @var string the encoding of the string value to be validated (e.g. 'UTF-8');
* if this property is not set, `\yii\base\Application::charset` will be used
*/
public $encoding;
/**
* @var string the base path for all translated messages; specify it if you want to use custom translated messages
*/
public $i18nBasePath;
/**
* @var int minimum number of domain name labels;
* defaults to 2, meaning that domain name should contain at least 2 labels
* @see messageLabelNumberMin for the customized message for domain name with too small number of labels
*/
public $labelNumberMin = 2;
/**
* @var string user-defined error message used when domain name is invalid but
* reason is too complicated for explanation to end-user or details are not needed at all;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
* @see simpleErrorMessage to use this message for all possible errors
*/
public $message;
/**
* @var string user-defined error message used when DNS record corresponding to domain name not found;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageDNS;
/**
* @var string user-defined error message used when domain name contains an invalid character;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageInvalidCharacter;
/**
* @var string user-defined error message used when number of domain name labels is smaller than `labelNumberMin`;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{labelNumberMin}`: the value of `labelNumberMin`
* - `{value}`: the value of the attribute being validated
*/
public $messageLabelNumberMin;
/**
* @var string user-defined error message used when domain name label starts or ends with an invalid character;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageLabelStartEnd;
/**
* @var string user-defined error message used when domain name label is too long;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageLabelTooLong;
/**
* @var string user-defined error message used when domain name label is too short;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageLabelTooShort;
/**
* @var string user-defined error message used when domain name is not a string;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageNotString;
/**
* @var string user-defined error message used when domain name is too long;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageTooLong;
/**
* @var string user-defined error message used when domain name is too short;
* you may use the following placeholders in the message:
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
*/
public $messageTooShort;
/**
* @var bool whether to always use simple error message;
* defaults to false, meaning that validator should use specialized error messages for different errors,
* it should help end-user to understand reason of error; set it to true if detailed error messages don't fit
* for your application then `message` will be used in all cases
*/
public $simpleErrorMessage = false;
/**
* {@inheritdoc}
*/
public function init()
{
parent::init();
if ($this->enableIDN && !function_exists('idn_to_ascii')) {
throw new InvalidConfigException(
'In order to use IDN validation intl extension must be installed and enabled.'
);
}
if (!isset($this->encoding)) {
$this->encoding = Yii::$app->charset;
}
if (!isset($this->i18nBasePath)) {
$this->i18nBasePath = dirname(__DIR__) . '/messages';
}
Yii::$app->i18n->translations['kdn/yii2/validators/domain'] = [
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => $this->i18nBasePath,
'fileMap' => ['kdn/yii2/validators/domain' => 'domain.php'],
];
}
/**
* {@inheritdoc}
*/
protected function validateValue($value)
{
if (!is_string($value)) {
return $this->getErrorMessage('messageNotString');
}
if (empty($value)) {
return $this->getErrorMessage('messageTooShort');
}
if ($this->allowURL) {
$host = parse_url($value, PHP_URL_HOST);
if (isset($host) && $host !== false) {
$value = $host;
}
}
if ($this->enableIDN) {
$idnaInfo = [];
$options = IDNA_CHECK_BIDI | IDNA_CHECK_CONTEXTJ;
$asciiValue = idn_to_ascii($value, $options, INTL_IDNA_VARIANT_UTS46, $idnaInfo);
if ($asciiValue !== false) {
$value = $asciiValue;
} else {
$idnaErrors = null;
if (is_array($idnaInfo) && array_key_exists('errors', $idnaInfo)) {
$idnaErrors = $idnaInfo['errors'];
}
if ($idnaErrors & IDNA_ERROR_DOMAIN_NAME_TOO_LONG) {
$errorMessageName = 'messageTooLong';
} elseif ($idnaErrors & IDNA_ERROR_EMPTY_LABEL) {
$errorMessageName = 'messageLabelTooShort';
} elseif ($idnaErrors & IDNA_ERROR_LABEL_TOO_LONG) {
$errorMessageName = 'messageLabelTooLong';
} elseif ($idnaErrors & IDNA_ERROR_DISALLOWED) {
$errorMessageName = 'messageInvalidCharacter';
} elseif ($idnaErrors & IDNA_ERROR_LEADING_HYPHEN || $idnaErrors & IDNA_ERROR_TRAILING_HYPHEN) {
$errorMessageName = 'messageLabelStartEnd';
} elseif (empty($idnaInfo)) {
// too long domain name caused buffer overflow
$errorMessageName = 'messageTooLong';
} else {
$errorMessageName = 'message';
}
return $this->getErrorMessage($errorMessageName);
}
}
// ignore trailing dot
if (mb_substr($value, -1, 1, $this->encoding) == '.') {
$value = substr_replace($value, '', -1);
}
// 253 characters limit is same as 127 levels,
// domain name with 127 levels with 1 character per label will be 253 characters long
if (mb_strlen($value, $this->encoding) > 253) {
return $this->getErrorMessage('messageTooLong');
}
$labels = explode('.', $value);
$labelsCount = count($labels);
if ($labelsCount < $this->labelNumberMin) {
return $this->getErrorMessage('messageLabelNumberMin', ['labelNumberMin' => $this->labelNumberMin]);
}
for ($i = 0; $i < $labelsCount; $i++) {
$label = $labels[$i];
$labelLength = mb_strlen($label, $this->encoding);
if (empty($label)) {
return $this->getErrorMessage('messageLabelTooShort');
}
if ($labelLength > 63) {
return $this->getErrorMessage('messageLabelTooLong');
}
if ($this->allowUnderscore) {
$pattern = '/^[a-z\d\-_]+$/i';
} else {
$pattern = '/^[a-z\d\-]+$/i';
}
if (!preg_match($pattern, $label)) {
return $this->getErrorMessage('messageInvalidCharacter');
}
if (
$i == $labelsCount - 1 && !ctype_alpha($label[0])
|| !ctype_alnum($label[0])
|| !ctype_alnum($label[$labelLength - 1])
) {
return $this->getErrorMessage('messageLabelStartEnd');
}
}
if ($this->checkDNS) {
if (is_callable($this->checkDNS)) {
return call_user_func($this->checkDNS, $value);
}
if (!$this->checkDNS($value)) {
return $this->getErrorMessage('messageDNS');
}
}
return null;
}
/**
* Check whether domain name exists.
* @param string $domain domain name
* @return bool whether domain name exists.
* @see https://github.com/yiisoft/yii2/issues/17083
* @see https://github.com/yiisoft/yii2/issues/17602
*/
protected function checkDNS($domain)
{
$normalizedDomain = "$domain.";
if (!checkdnsrr($normalizedDomain, 'ANY')) {
return false;
}
try {
// dns_get_record can return false and emit Warning that may or may not be converted to ErrorException
$records = dns_get_record($normalizedDomain, DNS_ANY);
} catch (ErrorException $e) {
return false;
}
return !empty($records);
}
/**
* Get error message by name.
* @param string $name error message name
* @param array $params parameters to be inserted into the error message
* @return array error message.
*/
protected function getErrorMessage($name, $params = [])
{
if ($this->simpleErrorMessage) {
$name = 'message';
}
if (isset($this->$name)) {
return [$this->$name, $params];
}
$this->$name = Yii::t('kdn/yii2/validators/domain', $this->getDefaultErrorMessages()[$name]);
return [$this->$name, $params];
}
/**
* Get default error messages.
* @return array default error messages.
*/
protected function getDefaultErrorMessages()
{
$messages = [
'message' => '{attribute} is invalid.',
'messageDNS' => 'DNS record corresponding to {attribute} not found.',
'messageLabelNumberMin' =>
'{attribute} should consist of at least {labelNumberMin, number} labels separated by ' .
'{labelNumberMin, plural, =2{dot} other{dots}}.',
'messageLabelTooShort' => 'Each label of {attribute} should contain at least 1 character.',
'messageNotString' => '{attribute} must be a string.',
'messageTooShort' => '{attribute} should contain at least 1 character.',
];
if ($this->enableIDN) {
$messages['messageLabelStartEnd'] =
'Each label of {attribute} should start and end with letter or number.' .
' The rightmost label of {attribute} should start with letter.';
$messages['messageLabelTooLong'] = 'Label of {attribute} is too long.';
$messages['messageTooLong'] = '{attribute} is too long.';
if ($this->allowUnderscore) {
$messages['messageInvalidCharacter'] =
'Each label of {attribute} can consist of only letters, numbers, hyphens and underscores.';
} else {
$messages['messageInvalidCharacter'] =
'Each label of {attribute} can consist of only letters, numbers and hyphens.';
}
} else {
$messages['messageLabelStartEnd'] =
'Each label of {attribute} should start and end with latin letter or number.' .
' The rightmost label of {attribute} should start with latin letter.';
$messages['messageLabelTooLong'] = 'Each label of {attribute} should contain at most 63 characters.';
$messages['messageTooLong'] = '{attribute} should contain at most 253 characters.';
if ($this->allowUnderscore) {
$messages['messageInvalidCharacter'] =
'Each label of {attribute} can consist of only latin letters, numbers, hyphens and underscores.';
} else {
$messages['messageInvalidCharacter'] =
'Each label of {attribute} can consist of only latin letters, numbers and hyphens.';
}
}
return $messages;
}
}