-
Notifications
You must be signed in to change notification settings - Fork 7
/
Oauth2Module.php
1250 lines (1130 loc) · 48.3 KB
/
Oauth2Module.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace rhertogh\Yii2Oauth2Server;
use Defuse\Crypto\Exception\BadFormatException;
use Defuse\Crypto\Exception\EnvironmentIsBrokenException;
use GuzzleHttp\Psr7\Response as Psr7Response;
use GuzzleHttp\Psr7\ServerRequest as Psr7ServerRequest;
use League\OAuth2\Server\CryptKey;
use League\OAuth2\Server\Grant\GrantTypeInterface;
use rhertogh\Yii2Oauth2Server\base\Oauth2BaseModule;
use rhertogh\Yii2Oauth2Server\components\server\tokens\Oauth2AccessTokenData;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2ClientController;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2DebugController;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2EncryptionController;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2MigrationsController;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2PersonalAccessTokenController;
use rhertogh\Yii2Oauth2Server\exceptions\Oauth2ServerException;
use rhertogh\Yii2Oauth2Server\helpers\DiHelper;
use rhertogh\Yii2Oauth2Server\helpers\Psr7Helper;
use rhertogh\Yii2Oauth2Server\interfaces\components\authorization\Oauth2ClientAuthorizationRequestInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\common\DefaultAccessTokenTtlInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\encryption\Oauth2CryptographerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\factories\encryption\Oauth2EncryptionKeyFactoryInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\factories\grants\base\Oauth2GrantTypeFactoryInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\openidconnect\scope\Oauth2OidcScopeCollectionInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\openidconnect\server\Oauth2OidcBearerTokenResponseInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\server\Oauth2AuthorizationServerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\components\server\Oauth2ResourceServerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\controllers\web\Oauth2CertificatesControllerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\controllers\web\Oauth2ConsentControllerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\controllers\web\Oauth2OidcControllerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\controllers\web\Oauth2ServerControllerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\controllers\web\Oauth2WellKnownControllerInterface;
use rhertogh\Yii2Oauth2Server\interfaces\filters\auth\Oauth2HttpBearerAuthInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\base\Oauth2EncryptedStorageInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2OidcUserInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\external\user\Oauth2UserInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ClientInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ScopeInterface;
use rhertogh\Yii2Oauth2Server\traits\DefaultAccessTokenTtlTrait;
use Yii;
use yii\base\BootstrapInterface;
use yii\base\InvalidArgumentException;
use yii\base\InvalidCallException;
use yii\base\InvalidConfigException;
use yii\console\Application as ConsoleApplication;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;
use yii\helpers\StringHelper;
use yii\i18n\PhpMessageSource;
use yii\validators\IpValidator;
use yii\web\Application as WebApplication;
use yii\web\GroupUrlRule;
use yii\web\IdentityInterface;
use yii\web\Response;
use yii\web\UrlRule;
/**
* This is the main module class for the Yii2 Oauth2 Server module.
* To use it, include it as a module in the application configuration like the following:
*
* ~~~
* return [
* 'bootstrap' => ['oauth2'],
* 'modules' => [
* 'oauth2' => [
* 'class' => 'rhertogh\Yii2Oauth2Server\Oauth2Module',
* // ... Please check docs/guide/start-installation.md further details
* ],
* ],
* ]
* ~~~
*
* @property \DateInterval|string|null $defaultAccessTokenTTL
* @since 1.0.0
*/
class Oauth2Module extends Oauth2BaseModule implements BootstrapInterface, DefaultAccessTokenTtlInterface
{
use DefaultAccessTokenTtlTrait;
/**
* Application type "web": http response.
* @since 1.0.0
*/
public const APPLICATION_TYPE_WEB = 'web';
/**
* Application type "console": cli response.
* @since 1.0.0
*/
public const APPLICATION_TYPE_CONSOLE = 'console';
/**
* Supported Application types.
* @since 1.0.0
*/
public const APPLICATION_TYPES = [
self::APPLICATION_TYPE_WEB,
self::APPLICATION_TYPE_CONSOLE,
];
/**
* "Authorization Server" Role, please see guide for details.
* @since 1.0.0
*/
public const SERVER_ROLE_AUTHORIZATION_SERVER = 1;
/**
* "Resource Server" Role, please see guide for details.
* @since 1.0.0
*/
public const SERVER_ROLE_RESOURCE_SERVER = 2;
/**
* Required settings when the server role includes Authorization Server
* @since 1.0.0
*/
protected const REQUIRED_SETTINGS_AUTHORIZATION_SERVER = [
'codesEncryptionKey',
'storageEncryptionKeys',
'defaultStorageEncryptionKey',
'privateKey',
'publicKey',
];
/**
* Encrypted Models
*
* @since 1.0.0
*/
protected const ENCRYPTED_MODELS = [
Oauth2ClientInterface::class,
];
/**
* Required settings when the server role includes Resource Server
* @since 1.0.0
*/
protected const REQUIRED_SETTINGS_RESOURCE_SERVER = [
'publicKey',
];
/**
* Prefix used in session storage of Client Authorization Requests
* @since 1.0.0
*/
protected const CLIENT_AUTHORIZATION_REQUEST_SESSION_PREFIX = 'OATH2_CLIENT_AUTHORIZATION_REQUEST_';
/**
* Controller mapping for the module. Will be parsed on `init()`.
* @since 1.0.0
*/
protected const CONTROLLER_MAP = [
self::APPLICATION_TYPE_WEB => [
Oauth2ServerControllerInterface::CONTROLLER_NAME => [
'controller' => Oauth2ServerControllerInterface::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
Oauth2ConsentControllerInterface::CONTROLLER_NAME => [
'controller' => Oauth2ConsentControllerInterface::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
Oauth2WellKnownControllerInterface::CONTROLLER_NAME => [
'controller' => Oauth2WellKnownControllerInterface::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
Oauth2CertificatesControllerInterface::CONTROLLER_NAME => [
'controller' => Oauth2CertificatesControllerInterface::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
Oauth2OidcControllerInterface::CONTROLLER_NAME => [
'controller' => Oauth2OidcControllerInterface::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
],
self::APPLICATION_TYPE_CONSOLE => [
'migrations' => [
'controller' => Oauth2MigrationsController::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER | self::SERVER_ROLE_RESOURCE_SERVER,
],
'client' => [
'controller' => Oauth2ClientController::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
'encryption' => [
'controller' => Oauth2EncryptionController::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
],
'debug' => [
'controller' => Oauth2DebugController::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER | self::SERVER_ROLE_RESOURCE_SERVER,
],
'pat' => [
'controller' => Oauth2PersonalAccessTokenController::class,
'serverRole' => self::SERVER_ROLE_AUTHORIZATION_SERVER,
]
]
];
/**
* @inheritdoc
*/
public $controllerNamespace = __NAMESPACE__ . '\-'; // Set explicitly via $controllerMap in `init()`.
/**
* @var string|null The application type. If `null` the type will be automatically detected.
* @see APPLICATION_TYPES
*/
public $appType = null;
/**
* @var int The Oauth 2.0 Server Roles the module will perform.
* @since 1.0.0
*/
public $serverRole = self::SERVER_ROLE_AUTHORIZATION_SERVER | self::SERVER_ROLE_RESOURCE_SERVER;
/**
* @var string|null The private key for the server. Can be a string containing the key itself or point to a file.
* When pointing to a file it's recommended to use an absolute path prefixed with 'file://' or start with
* '@' to use a Yii path alias.
* @see $privateKeyPassphrase For setting a passphrase for the private key.
* @since 1.0.0
*/
public $privateKey = null;
/**
* @var string|null The passphrase for the private key.
* @since 1.0.0
*/
public $privateKeyPassphrase = null;
/**
* @var string|null The public key for the server. Can be a string containing the key itself or point to a file.
* When pointing to a file it's recommended to use an absolute path prefixed with 'file://' or start with
* '@' to use a Yii path alias.
* @since 1.0.0
*/
public $publicKey = null;
/**
* @var string|null The encryption key for authorization and refresh codes.
* @since 1.0.0
*/
public $codesEncryptionKey = null;
/**
* @var string[]|string|null The encryption keys for storage like client secrets.
* Where the array key is the name of the key, and the value the key itself. E.g.
* `['2022-01-01' => 'def00000cb36fd6ed6641e0ad70805b28d....']`
* If a string (instead of an array of strings) is specified it will be JSON decoded
* it should contain an object where each property name is the name of the key, its value the key itself. E.g.
* `{"2022-01-01": "def00000cb36fd6ed6641e0ad70805b28d...."}`
*
* @since 1.0.0
*/
public $storageEncryptionKeys = null;
/**
* @var string|null The index of the default key in storageEncryptionKeys. E.g. 'myKey'.
* @since 1.0.0
*/
public $defaultStorageEncryptionKey = null;
/**
* @var string|string[]|null IP addresses, CIDR ranges, or range aliases that are allowed to connect over a
* non-TLS connection. If `null` or an empty array LTS is always required.
*
* Warning: Although you can use '*' or 'any' to allow a non-TLS connection from any ip address,
* doing so would most likely introduce a security risk and should be done for debugging purposes only!
*
* @see \yii\validators\IpValidator::$networks for a list of available alliasses.
*/
public $nonTlsAllowedRanges = 'localhost';
/**
* @var class-string<Oauth2UserInterface>|null The Identity Class of your application,
* most likely the same as the 'identityClass' of your application's User Component.
* @since 1.0.0
*/
public $identityClass = null;
/**
* @var null|string Prefix used for url rules. When `null` the module's uniqueId will be used.
* @since 1.0.0
*/
public $urlRulesPrefix = null;
/**
* @var string URL path for the access token endpoint (will be prefixed with $urlRulesPrefix).
* @since 1.0.0
*/
public $authorizePath = 'authorize';
/**
* @var string URL path for the access token endpoint (will be prefixed with $urlRulesPrefix).
* @since 1.0.0
*/
public $accessTokenPath = 'access-token';
/**
* @var string URL path for the certificates jwks endpoint (will be prefixed with $urlRulesPrefix).
* @since 1.0.0
*/
public $jwksPath = 'certs';
/**
* The URL to the page where the user can perform the client/scope authorization
* (if `null` the build in page will be used).
* @return string
* @since 1.0.0
*/
public $clientAuthorizationUrl = null;
/**
* @var string The URL path to the build in page where the user can authorize the client for the requested scopes
* (will be prefixed with $urlRulesPrefix).
* Note: This setting will only be used if $clientAuthorizationUrl is `null`.
* @since 1.0.0
*/
public $clientAuthorizationPath = 'authorize-client';
/**
* @var string The view to use in the "client authorization action" for the page where the user can
* authorize the client for the requested scopes.
* Note: This setting will only be used if $clientAuthorizationUrl is `null`.
* @since 1.0.0
*/
public $clientAuthorizationView = 'authorize-client';
/**
* Configuration for `Oauth2Client::getRedirectUrisEnvVarConfig()` fallback (the
* Oauth2Client::$envVarConfig['redirectUris'] has precedence).
* When configured, environment variables specified in the `Oauth2Client` redirect URI(s) will be substituted with
* their values. Please see `EnvironmentHelper::parseEnvVars()` for more details.
*
* Warning: This setting applies to all clients, for security it's recommended to specify this configuration at the
* individual client level via its `envVarConfig` setting.
*
* @var array{
* allowList: array,
* denyList: array|null,
* parseNested: bool,
* exceptionWhenNotSet: bool,
* exceptionWhenNotAllowed: bool,
* }|null
* @see Oauth2ClientInterface::setEnvVarConfig()
* @see Oauth2ClientInterface::getRedirectUrisEnvVarConfig()
* @see \rhertogh\Yii2Oauth2Server\helpers\EnvironmentHelper::parseEnvVars()
*/
public $clientRedirectUrisEnvVarConfig = null;
/**
* @var string|null The URL path to the OpenID Connect Provider Configuration Information Action.
* If set to `null` the endpoint will be disabled.
* Note: This path is defined in the
* [OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#rfc.section.4)
* specification and should normally not be changed.
* @since 1.0.0
*/
public $openIdConnectProviderConfigurationInformationPath = '.well-known/openid-configuration';
/**
* @var string The URL path to the OpenID Connect Userinfo Action (will be prefixed with $urlRulesPrefix).
* Note: This setting will only be used if $enableOpenIdConnect and $openIdConnectUserinfoEndpoint are `true`.
* @since 1.0.0
*/
public $openIdConnectUserinfoPath = 'oidc/userinfo';
/**
* @var Oauth2GrantTypeFactoryInterface[]|GrantTypeInterface[]|string[]|Oauth2GrantTypeFactoryInterface|GrantTypeInterface|string|callable
* The Oauth 2.0 Grant Types that the module will serve.
* @since 1.0.0
*/
public $grantTypes = [];
/**
* @var bool Should the resource server check for revocation of the access token.
* @since 1.0.0
*/
public $resourceServerAccessTokenRevocationValidation = true;
/**
* @var bool Enable support for OpenIdvConnect.
* @since 1.0.0
*/
public $enableOpenIdConnect = false;
/**
* @var bool Enable the .well-known/openid-configuration discovery endpoint.
* @since 1.0.0
*/
public $enableOpenIdConnectDiscovery = true;
/**
* @var bool include `grant_types_supported` in the OpenIdConnect Discovery.
* Note: Since grant types can be specified per client not all clients might support all enabled grant types.
* @since 1.0.0
*/
public $openIdConnectDiscoveryIncludeSupportedGrantTypes = true;
/**
* @var string URL to include in the OpenID Connect Discovery Service of a page containing
* human-readable information that developers might want or need to know when using the OpenID Provider.
* @see 'service_documentation' in https://openid.net/specs/openid-connect-discovery-1_0.html#rfc.section.3
* @since 1.0.0
*/
public $openIdConnectDiscoveryServiceDocumentationUrl = null;
/**
* @var string|bool A string to a custom userinfo endpoint or `true` to enable the build in endpoint.
* @since 1.0.0
*/
public $openIdConnectUserinfoEndpoint = true;
/**
* Warning! Enabling this setting might introduce privacy concerns since the client could poll for the
* online status of a user.
*
* @var bool If this setting is disabled in case of OpenID Connect Context the Access Token won't include a
* Refresh Token when the 'offline_access' scope is not included in the authorization request.
* In some cases it might be needed to always include a Refresh Token, in that case enable this setting and
* implement the `Oauth2OidcUserSessionStatusInterface` on the User Identity model.
* @since 1.0.0
*/
public $openIdConnectIssueRefreshTokenWithoutOfflineAccessScope = false;
/**
* @var int The default option for "User Account Selection' when not specified for a client.
* @since 1.0.0
*/
public $defaultUserAccountSelection = self::USER_ACCOUNT_SELECTION_DISABLED;
/**
* @var bool|null Display exception messages that might leak server details. This could be useful for debugging.
* In case of `null` (default) the YII_DEBUG constant will be used.
* Warning: Should NOT be enabled in production!
* @since 1.0.0
*/
public $displayConfidentialExceptionMessages = null;
/**
* @var string|null The namespace with which migrations will be created (and by which they will be located).
* Note: The specified namespace must be defined as a Yii alias (e.g. '@app').
* @since 1.0.0
*/
public $migrationsNamespace = null;
/**
* @var string|null Optional prefix used in the name of generated migrations
* @since 1.0.0
*/
public $migrationsPrefix = null;
/**
* @var string|array|int|null Sets the file ownership of generated migrations
* @see \yii\helpers\BaseFileHelper::changeOwnership()
* @since 1.0.0
*/
public $migrationsFileOwnership = null;
/**
* @var int|null Sets the file mode of generated migrations
* @see \yii\helpers\BaseFileHelper::changeOwnership()
* @since 1.0.0
*/
public $migrationsFileMode = null;
/**
* @var Oauth2AuthorizationServerInterface|null Cache for the authorization server
* @since 1.0.0
*/
protected $_authorizationServer = null;
/**
* @var Oauth2ResourceServerInterface|null Cache for the resource server
* @since 1.0.0
*/
protected $_resourceServer = null;
/**
* @var Oauth2CryptographerInterface|null Cache for the Oauth2Cryptographer
* @since 1.0.0
*/
protected $_cryptographer = null;
/**
* @var string|null The authorization header used when the authorization request was validated.
* @since 1.0.0
*/
protected $_oauthClaimsAuthorizationHeader = null;
/**
* @inheritDoc
* @throws InvalidConfigException
*/
public function init()
{
parent::init();
$app = Yii::$app;
if ($app instanceof WebApplication || $this->appType == static::APPLICATION_TYPE_WEB) {
$controllerMap = static::CONTROLLER_MAP[static::APPLICATION_TYPE_WEB];
} elseif ($app instanceof ConsoleApplication || $this->appType == static::APPLICATION_TYPE_CONSOLE) {
$controllerMap = static::CONTROLLER_MAP[static::APPLICATION_TYPE_CONSOLE];
} else {
throw new InvalidConfigException(
'Unable to detect application type, configure it manually by setting `$appType`.'
);
}
$controllerMap = array_filter(
$controllerMap,
fn($controllerSettings) => $controllerSettings['serverRole'] & $this->serverRole
);
$this->controllerMap = ArrayHelper::getColumn($controllerMap, 'controller');
if (empty($this->identityClass)) {
throw new InvalidConfigException('$identityClass must be set.');
} elseif (!is_a($this->identityClass, Oauth2UserInterface::class, true)) {
throw new InvalidConfigException(
$this->identityClass . ' must implement ' . Oauth2UserInterface::class
);
}
foreach (static::DEFAULT_INTERFACE_IMPLEMENTATIONS as $interface => $implementation) {
if (!Yii::$container->has($interface)) {
Yii::$container->set($interface, $implementation);
}
}
if (empty($this->urlRulesPrefix)) {
$this->urlRulesPrefix = $this->uniqueId;
}
$this->registerTranslations();
}
/**
* @inheritdoc
* @throws InvalidConfigException
*/
public function bootstrap($app)
{
if (
$app instanceof WebApplication
&& $this->serverRole & static::SERVER_ROLE_AUTHORIZATION_SERVER
) {
$rules = [
$this->accessTokenPath => Oauth2ServerControllerInterface::CONTROLLER_NAME
. '/' . Oauth2ServerControllerInterface::ACTION_NAME_ACCESS_TOKEN,
$this->authorizePath => Oauth2ServerControllerInterface::CONTROLLER_NAME
. '/' . Oauth2ServerControllerInterface::ACTION_NAME_AUTHORIZE,
$this->jwksPath => Oauth2CertificatesControllerInterface::CONTROLLER_NAME
. '/' . Oauth2CertificatesControllerInterface::ACTION_NAME_JWKS,
];
if (empty($this->clientAuthorizationUrl)) {
$rules[$this->clientAuthorizationPath] = Oauth2ConsentControllerInterface::CONTROLLER_NAME
. '/' . Oauth2ConsentControllerInterface::ACTION_NAME_AUTHORIZE_CLIENT;
}
if ($this->enableOpenIdConnect && $this->openIdConnectUserinfoEndpoint === true) {
$rules[$this->openIdConnectUserinfoPath] =
Oauth2OidcControllerInterface::CONTROLLER_NAME
. '/' . Oauth2OidcControllerInterface::ACTION_NAME_USERINFO;
}
$urlManager = $app->getUrlManager();
$urlManager->addRules([
Yii::createObject([
'class' => GroupUrlRule::class,
'prefix' => $this->urlRulesPrefix,
'routePrefix' => $this->id,
'rules' => $rules,
]),
]);
if (
$this->enableOpenIdConnect
&& $this->enableOpenIdConnectDiscovery
&& $this->openIdConnectProviderConfigurationInformationPath
) {
$urlManager->addRules([
Yii::createObject([
'class' => UrlRule::class,
'pattern' => $this->openIdConnectProviderConfigurationInformationPath,
'route' => $this->id
. '/' . Oauth2WellKnownControllerInterface::CONTROLLER_NAME
. '/' . Oauth2WellKnownControllerInterface::ACTION_NAME_OPENID_CONFIGURATION,
]),
]);
}
}
}
/**
* Registers the translations for the module
* @param bool $force Force the setting of the translations (even if they are already defined).
* @since 1.0.0
*/
public function registerTranslations($force = false)
{
if ($force || !array_key_exists('oauth2', Yii::$app->i18n->translations)) {
Yii::$app->i18n->translations['oauth2'] = [
'class' => PhpMessageSource::class,
'sourceLanguage' => 'en-US',
'basePath' => __DIR__ . DIRECTORY_SEPARATOR . 'messages',
'fileMap' => [
'oauth2' => 'oauth2.php',
],
];
}
}
/**
* @param string $identifier The client identifier
* @param string $name The (user-friendly) name of the client
* @param int $grantTypes The grant types enabled for this client.
* Use bitwise `OR` to combine multiple types,
* e.g. `Oauth2Module::GRANT_TYPE_AUTH_CODE | Oauth2Module::GRANT_TYPE_REFRESH_TOKEN`
* @param string|string[] $redirectURIs One or multiple redirect URIs for the client
* @param int $type The client type (e.g. Confidential or Public)
* See `\rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ClientInterface::TYPES` for possible values
* @param string|null $secret The client secret in case the client `type` is `confidential`.
* @param string|string[]|array[]|Oauth2ScopeInterface[]|null $scopes
* @param int|null $userId
* @return Oauth2ClientInterface
* @throws InvalidConfigException
* @throws \yii\db\Exception
*/
public function createClient(
$identifier,
$name,
$grantTypes,
$redirectURIs,
$type,
$secret = null,
$scopes = null,
$userId = null,
$endUsersMayAuthorizeClient = null,
$skipAuthorizationIfScopeIsAllowed = null
) {
if (!($this->serverRole & static::SERVER_ROLE_AUTHORIZATION_SERVER)) {
throw new InvalidCallException('Oauth2 server role does not include authorization server.');
}
/** @var Oauth2ClientInterface $client */
$client = Yii::createObject([
'class' => Oauth2ClientInterface::class,
'identifier' => $identifier,
'type' => $type,
'name' => $name,
'redirectUri' => $redirectURIs,
'grantTypes' => $grantTypes,
'endUsersMayAuthorizeClient' => $endUsersMayAuthorizeClient,
'skip_authorization_if_scope_is_allowed' => $skipAuthorizationIfScopeIsAllowed,
'clientCredentialsGrantUserId' => $userId
]);
$transaction = $client::getDb()->beginTransaction();
try {
if ($type == Oauth2ClientInterface::TYPE_CONFIDENTIAL) {
$client->setSecret($secret, $this->getCryptographer());
}
$client
->persist()
->syncClientScopes($scopes, $this->getScopeRepository());
$transaction->commit();
} catch (\Exception $e) {
$transaction->rollBack();
throw $e;
}
return $client;
}
/**
* @return CryptKey The private key of the server.
* @throws InvalidConfigException
* @since 1.0.0
*/
public function getPrivateKey()
{
$privateKey = $this->privateKey;
if (StringHelper::startsWith($privateKey, '@')) {
$privateKey = 'file://' . Yii::getAlias($privateKey);
}
return Yii::createObject(CryptKey::class, [$privateKey, $this->privateKeyPassphrase]);
}
/**
* @return CryptKey The public key of the server.
* @throws InvalidConfigException
* @since 1.0.0
*/
public function getPublicKey()
{
$publicKey = $this->publicKey;
if (StringHelper::startsWith($publicKey, '@')) {
$publicKey = 'file://' . Yii::getAlias($publicKey);
}
return Yii::createObject(CryptKey::class, [$publicKey]);
}
/**
* @return Oauth2AuthorizationServerInterface The authorization server.
* @throws InvalidConfigException
* @since 1.0.0
*/
public function getAuthorizationServer()
{
if (!($this->serverRole & static::SERVER_ROLE_AUTHORIZATION_SERVER)) {
throw new InvalidCallException('Oauth2 server role does not include authorization server.');
}
if (!$this->_authorizationServer) {
$this->ensureProperties(static::REQUIRED_SETTINGS_AUTHORIZATION_SERVER);
if (!$this->getCryptographer()->hasKey($this->defaultStorageEncryptionKey)) {
throw new InvalidConfigException(
'Key "' . $this->defaultStorageEncryptionKey . '" is not set in $storageEncryptionKeys'
);
}
/** @var Oauth2EncryptionKeyFactoryInterface $keyFactory */
$keyFactory = Yii::createObject(Oauth2EncryptionKeyFactoryInterface::class);
try {
$codesEncryptionKey = $keyFactory->createFromAsciiSafeString($this->codesEncryptionKey);
} catch (BadFormatException $e) {
throw new InvalidConfigException(
'$codesEncryptionKey is malformed: ' . $e->getMessage(),
0,
$e
);
} catch (EnvironmentIsBrokenException $e) {
throw new InvalidConfigException(
'Could not instantiate $codesEncryptionKey: ' . $e->getMessage(),
0,
$e
);
}
$responseType = null;
if ($this->enableOpenIdConnect) {
$responseType = Yii::createObject(Oauth2OidcBearerTokenResponseInterface::class, [
$this,
]);
}
$this->_authorizationServer = Yii::createObject(Oauth2AuthorizationServerInterface::class, [
$this->getClientRepository(),
$this->getAccessTokenRepository(),
$this->getScopeRepository(),
$this->getPrivateKey(),
$codesEncryptionKey,
$responseType
]);
if (!empty($this->grantTypes)) {
$grantTypes = $this->grantTypes;
if (is_callable($grantTypes)) {
call_user_func($grantTypes, $this->_authorizationServer, $this);
} else {
if (!is_array($grantTypes)) {
$grantTypes = [$grantTypes];
}
foreach ($grantTypes as $grantTypeDefinition) {
if ($grantTypeDefinition instanceof GrantTypeInterface) {
$accessTokenTTL = $this->getDefaultAccessTokenTTL();
$this->_authorizationServer->enableGrantType($grantTypeDefinition, $accessTokenTTL);
} elseif (
(
is_numeric($grantTypeDefinition)
&& array_key_exists($grantTypeDefinition, static::DEFAULT_GRANT_TYPE_FACTORIES)
)
|| is_a($grantTypeDefinition, Oauth2GrantTypeFactoryInterface::class, true)
) {
if (
is_numeric($grantTypeDefinition)
&& array_key_exists($grantTypeDefinition, static::DEFAULT_GRANT_TYPE_FACTORIES)
) {
$grantTypeDefinition = static::DEFAULT_GRANT_TYPE_FACTORIES[$grantTypeDefinition];
}
/** @var Oauth2GrantTypeFactoryInterface $factory */
$factory = Yii::createObject([
'class' => $grantTypeDefinition,
'module' => $this,
]);
$accessTokenTTL = $factory->getDefaultAccessTokenTTL()
?? $this->getDefaultAccessTokenTTL();
$this->_authorizationServer->enableGrantType($factory->getGrantType(), $accessTokenTTL);
} else {
throw new InvalidConfigException(
'Unknown grantType '
. (
is_scalar($grantTypeDefinition)
? '"' . $grantTypeDefinition . '".'
: 'with data type ' . gettype($grantTypeDefinition)
)
);
}
}
}
}
}
return $this->_authorizationServer;
}
/**
* @inheritDoc
* @throws InvalidConfigException
*/
public function getOidcScopeCollection()
{
if ($this->_oidcScopeCollection === null) {
$openIdConnectScopes = $this->getOpenIdConnectScopes();
if ($openIdConnectScopes instanceof Oauth2OidcScopeCollectionInterface) {
$this->_oidcScopeCollection = $openIdConnectScopes;
} elseif (is_callable($openIdConnectScopes)) {
$this->_oidcScopeCollection = call_user_func($openIdConnectScopes, $this);
if (!($this->_oidcScopeCollection instanceof Oauth2OidcScopeCollectionInterface)) {
throw new InvalidConfigException(
'$openIdConnectScopes must return an instance of '
. Oauth2OidcScopeCollectionInterface::class
);
}
} elseif (is_array($openIdConnectScopes) || is_string($openIdConnectScopes)) {
$this->_oidcScopeCollection = Yii::createObject([
'class' => Oauth2OidcScopeCollectionInterface::class,
'oidcScopes' => (array)$openIdConnectScopes,
]);
} else {
throw new InvalidConfigException(
'$openIdConnectScopes must be a callable, array, string or '
. Oauth2OidcScopeCollectionInterface::class
);
}
}
return $this->_oidcScopeCollection;
}
/**
* @return Oauth2ResourceServerInterface The resource server.
* @throws InvalidConfigException
* @since 1.0.0
*/
public function getResourceServer()
{
if (!($this->serverRole & static::SERVER_ROLE_RESOURCE_SERVER)) {
throw new InvalidCallException('Oauth2 server role does not include resource server.');
}
if (!$this->_resourceServer) {
$this->ensureProperties(static::REQUIRED_SETTINGS_RESOURCE_SERVER);
$accessTokenRepository = $this->getAccessTokenRepository()
->setRevocationValidation($this->resourceServerAccessTokenRevocationValidation);
$this->_resourceServer = Yii::createObject(Oauth2ResourceServerInterface::class, [
$accessTokenRepository,
$this->getPublicKey(),
]);
}
return $this->_resourceServer;
}
/**
* @return Oauth2CryptographerInterface The data cryptographer for the module.
* @throws InvalidConfigException
* @since 1.0.0
*/
public function getCryptographer()
{
if (!$this->_cryptographer) {
$this->_cryptographer = Yii::createObject([
'class' => Oauth2CryptographerInterface::class,
'keys' => $this->storageEncryptionKeys,
'defaultKeyName' => $this->defaultStorageEncryptionKey,
]);
}
return $this->_cryptographer;
}
/**
* @param string|null $newKeyName
* @return array
* @throws InvalidConfigException
*/
public function rotateStorageEncryptionKeys($newKeyName = null)
{
$cryptographer = $this->getCryptographer();
$result = [];
foreach (static::ENCRYPTED_MODELS as $modelInterface) {
$modelClass = DiHelper::getValidatedClassName($modelInterface);
if (!is_a($modelClass, Oauth2EncryptedStorageInterface::class, true)) {
throw new InvalidConfigException($modelInterface . ' must implement '
. Oauth2EncryptedStorageInterface::class);
}
$result[$modelClass] = $modelClass::rotateStorageEncryptionKeys($cryptographer, $newKeyName);
}
return $result;
}
/**
* Checks if the connection is using TLS or if the remote IP address is allowed to connect without TLS.
* @return bool
*/
public function validateTlsConnection()
{
if (Yii::$app->request->getIsSecureConnection()) {
return true;
}
if (
!empty($this->nonTlsAllowedRanges)
&& (new IpValidator(['ranges' => $this->nonTlsAllowedRanges]))->validate(Yii::$app->request->getRemoteIP())
) {
return true;
}
return false;
}
/**
* @return array
* @throws InvalidConfigException
*/
public function getStorageEncryptionKeyUsage()
{
$cryptographer = $this->getCryptographer();
$result = [];
foreach (static::ENCRYPTED_MODELS as $modelInterface) {
$modelClass = DiHelper::getValidatedClassName($modelInterface);
if (!is_a($modelClass, Oauth2EncryptedStorageInterface::class, true)) {
throw new InvalidConfigException($modelInterface . ' must implement '
. Oauth2EncryptedStorageInterface::class);
}
$result[$modelClass] = $modelClass::getUsedStorageEncryptionKeys($cryptographer);
}
return $result;
}
/**
* Generates a redirect Response to the client authorization page where the user is prompted to authorize the
* client and requested scope.
* @param Oauth2ClientAuthorizationRequestInterface $clientAuthorizationRequest
* @return Response
* @since 1.0.0
*/
public function generateClientAuthReqRedirectResponse($clientAuthorizationRequest)
{
$this->setClientAuthReqSession($clientAuthorizationRequest);
if (!empty($this->clientAuthorizationUrl)) {
$url = $this->clientAuthorizationUrl;
} else {
$url = $this->uniqueId
. '/' . Oauth2ConsentControllerInterface::CONTROLLER_NAME
. '/' . Oauth2ConsentControllerInterface::ACTION_NAME_AUTHORIZE_CLIENT;
}
return Yii::$app->response->redirect([
$url,
'clientAuthorizationRequestId' => $clientAuthorizationRequest->getRequestId(),
]);
}
/**
* Get a previously stored Client Authorization Request from the session.
* @param string $requestId
* @return Oauth2ClientAuthorizationRequestInterface|null
* @since 1.0.0
*/
public function getClientAuthReqSession($requestId)
{
if (empty($requestId)) {
return null;
}
$key = static::CLIENT_AUTHORIZATION_REQUEST_SESSION_PREFIX . $requestId;
$clientAuthorizationRequest = Yii::$app->session->get($key);
if (!($clientAuthorizationRequest instanceof Oauth2ClientAuthorizationRequestInterface)) {
if (!empty($clientAuthorizationRequest)) {
Yii::warning(
'Found a ClientAuthorizationRequestSession with key "' . $key
. '", but it\'s not a ' . Oauth2ClientAuthorizationRequestInterface::class
);
}