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
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Oauth
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id$
*/
/** Zend_Oauth */
#require_once 'Zend/Oauth.php';
/** Zend_Uri */
#require_once 'Zend/Uri.php';
/** Zend_Oauth_Config_Interface */
#require_once 'Zend/Oauth/Config/ConfigInterface.php';
/**
* @category Zend
* @package Zend_Oauth
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Oauth_Config implements Zend_Oauth_Config_ConfigInterface
{
/**
* Signature method used when signing all parameters for an HTTP request
*
* @var string
*/
protected $_signatureMethod = 'HMAC-SHA1';
/**
* Three request schemes are defined by OAuth, of which passing
* all OAuth parameters by Header is preferred. The other two are
* POST Body and Query String.
*
* @var string
*/
protected $_requestScheme = Zend_Oauth::REQUEST_SCHEME_HEADER;
/**
* Preferred request Method - one of GET or POST - which Zend_Oauth
* will enforce as standard throughout the library. Generally a default
* of POST works fine unless a Provider specifically requires otherwise.
*
* @var string
*/
protected $_requestMethod = Zend_Oauth::POST;
/**
* OAuth Version; This defaults to 1.0 - Must not be changed!
*
* @var string
*/
protected $_version = '1.0';
/**
* This optional value is used to define where the user is redirected to
* after authorizing a Request Token from an OAuth Providers website.
* It's optional since a Provider may ask for this to be defined in advance
* when registering a new application for a Consumer Key.
*
* @var string
*/
protected $_callbackUrl = null;
/**
* The URL root to append default OAuth endpoint paths.
*
* @var string
*/
protected $_siteUrl = null;
/**
* The URL to which requests for a Request Token should be directed.
* When absent, assumed siteUrl+'/request_token'
*
* @var string
*/
protected $_requestTokenUrl = null;
/**
* The URL to which requests for an Access Token should be directed.
* When absent, assumed siteUrl+'/access_token'
*
* @var string
*/
protected $_accessTokenUrl = null;
/**
* The URL to which users should be redirected to authorize a Request Token.
* When absent, assumed siteUrl+'/authorize'
*
* @var string
*/
protected $_authorizeUrl = null;
/**
* An OAuth application's Consumer Key.
*
* @var string
*/
protected $_consumerKey = null;
/**
* Every Consumer Key has a Consumer Secret unless you're in RSA-land.
*
* @var string
*/
protected $_consumerSecret = null;
/**
* If relevant, a PEM encoded RSA private key encapsulated as a
* Zend_Crypt_Rsa Key
*
* @var Zend_Crypt_Rsa_Key_Private
*/
protected $_rsaPrivateKey = null;
/**
* If relevant, a PEM encoded RSA public key encapsulated as a
* Zend_Crypt_Rsa Key
*
* @var Zend_Crypt_Rsa_Key_Public
*/
protected $_rsaPublicKey = null;
/**
* Generally this will nearly always be an Access Token represented as a
* Zend_Oauth_Token_Access object.
*
* @var Zend_Oauth_Token
*/
protected $_token = null;
/**
* Define the OAuth realm
*
* @var string
*/
protected $_realm = null;
/**
* Constructor; create a new object with an optional array|Zend_Config
* instance containing initialising options.
*
* @param array|Zend_Config $options
* @return void
*/
public function __construct($options = null)
{
if ($options !== null) {
if ($options instanceof Zend_Config) {
$options = $options->toArray();
}
$this->setOptions($options);
}
}
/**
* Parse option array or Zend_Config instance and setup options using their
* relevant mutators.
*
* @param array|Zend_Config $options
* @return Zend_Oauth_Config
*/
public function setOptions(array $options)
{
foreach ($options as $key => $value) {
switch ($key) {
case 'consumerKey':
$this->setConsumerKey($value);
break;
case 'consumerSecret':
$this->setConsumerSecret($value);
break;
case 'signatureMethod':
$this->setSignatureMethod($value);
break;
case 'version':
$this->setVersion($value);
break;
case 'callbackUrl':
$this->setCallbackUrl($value);
break;
case 'siteUrl':
$this->setSiteUrl($value);
break;
case 'requestTokenUrl':
$this->setRequestTokenUrl($value);
break;
case 'accessTokenUrl':
$this->setAccessTokenUrl($value);
break;
case 'userAuthorizationUrl':
$this->setUserAuthorizationUrl($value);
break;
case 'authorizeUrl':
$this->setAuthorizeUrl($value);
break;
case 'requestMethod':
$this->setRequestMethod($value);
break;
case 'rsaPrivateKey':
$this->setRsaPrivateKey($value);
break;
case 'rsaPublicKey':
$this->setRsaPublicKey($value);
break;
case 'realm':
$this->setRealm($value);
break;
}
}
if (isset($options['requestScheme'])) {
$this->setRequestScheme($options['requestScheme']);
}
return $this;
}
/**
* Set consumer key
*
* @param string $key
* @return Zend_Oauth_Config
*/
public function setConsumerKey($key)
{
$this->_consumerKey = $key;
return $this;
}
/**
* Get consumer key
*
* @return string
*/
public function getConsumerKey()
{
return $this->_consumerKey;
}
/**
* Set consumer secret
*
* @param string $secret
* @return Zend_Oauth_Config
*/
public function setConsumerSecret($secret)
{
$this->_consumerSecret = $secret;
return $this;
}
/**
* Get consumer secret
*
* Returns RSA private key if set; otherwise, returns any previously set
* consumer secret.
*
* @return string
*/
public function getConsumerSecret()
{
if ($this->_rsaPrivateKey !== null) {
return $this->_rsaPrivateKey;
}
return $this->_consumerSecret;
}
/**
* Set signature method
*
* @param string $method
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception if unsupported signature method specified
*/
public function setSignatureMethod($method)
{
$method = strtoupper($method);
if (!in_array($method, array(
'HMAC-SHA1', 'HMAC-SHA256', 'RSA-SHA1', 'PLAINTEXT'
))
) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception('Unsupported signature method: '
. $method
. '. Supported are HMAC-SHA1, RSA-SHA1, PLAINTEXT and HMAC-SHA256');
}
$this->_signatureMethod = $method;;
return $this;
}
/**
* Get signature method
*
* @return string
*/
public function getSignatureMethod()
{
return $this->_signatureMethod;
}
/**
* Set request scheme
*
* @param string $scheme
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception if invalid scheme specified, or if POSTBODY set when request method of GET is specified
*/
public function setRequestScheme($scheme)
{
$scheme = strtolower($scheme);
if (!in_array($scheme, array(
Zend_Oauth::REQUEST_SCHEME_HEADER,
Zend_Oauth::REQUEST_SCHEME_POSTBODY,
Zend_Oauth::REQUEST_SCHEME_QUERYSTRING,
))
) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $scheme . '\' is an unsupported request scheme'
);
}
if ($scheme == Zend_Oauth::REQUEST_SCHEME_POSTBODY
&& $this->getRequestMethod() == Zend_Oauth::GET
) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'Cannot set POSTBODY request method if HTTP method set to GET'
);
}
$this->_requestScheme = $scheme;
return $this;
}
/**
* Get request scheme
*
* @return string
*/
public function getRequestScheme()
{
return $this->_requestScheme;
}
/**
* Set version
*
* @param string $version
* @return Zend_Oauth_Config
*/
public function setVersion($version)
{
$this->_version = $version;
return $this;
}
/**
* Get version
*
* @return string
*/
public function getVersion()
{
return $this->_version;
}
/**
* Set callback URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setCallbackUrl($url)
{
if (!Zend_Uri::check($url) && $url !== 'oob') {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $url . '\' is not a valid URI'
);
}
$this->_callbackUrl = $url;
return $this;
}
/**
* Get callback URL
*
* @return string
*/
public function getCallbackUrl()
{
return $this->_callbackUrl;
}
/**
* Set site URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setSiteUrl($url)
{
if (!Zend_Uri::check($url)) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $url . '\' is not a valid URI'
);
}
$this->_siteUrl = $url;
return $this;
}
/**
* Get site URL
*
* @return string
*/
public function getSiteUrl()
{
return $this->_siteUrl;
}
/**
* Set request token URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setRequestTokenUrl($url)
{
if (!Zend_Uri::check($url)) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $url . '\' is not a valid URI'
);
}
$this->_requestTokenUrl = rtrim($url, '/');
return $this;
}
/**
* Get request token URL
*
* If no request token URL has been set, but a site URL has, returns the
* site URL with the string "/request_token" appended.
*
* @return string
*/
public function getRequestTokenUrl()
{
if (!$this->_requestTokenUrl && $this->_siteUrl) {
return $this->_siteUrl . '/request_token';
}
return $this->_requestTokenUrl;
}
/**
* Set access token URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setAccessTokenUrl($url)
{
if (!Zend_Uri::check($url)) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $url . '\' is not a valid URI'
);
}
$this->_accessTokenUrl = rtrim($url, '/');
return $this;
}
/**
* Get access token URL
*
* If no access token URL has been set, but a site URL has, returns the
* site URL with the string "/access_token" appended.
*
* @return string
*/
public function getAccessTokenUrl()
{
if (!$this->_accessTokenUrl && $this->_siteUrl) {
return $this->_siteUrl . '/access_token';
}
return $this->_accessTokenUrl;
}
/**
* Set user authorization URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setUserAuthorizationUrl($url)
{
return $this->setAuthorizeUrl($url);
}
/**
* Set authorization URL
*
* @param string $url
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid URLs
*/
public function setAuthorizeUrl($url)
{
if (!Zend_Uri::check($url)) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception(
'\'' . $url . '\' is not a valid URI'
);
}
$this->_authorizeUrl = rtrim($url, '/');
return $this;
}
/**
* Get user authorization URL
*
* @return string
*/
public function getUserAuthorizationUrl()
{
return $this->getAuthorizeUrl();
}
/**
* Get authorization URL
*
* If no authorization URL has been set, but a site URL has, returns the
* site URL with the string "/authorize" appended.
*
* @return string
*/
public function getAuthorizeUrl()
{
if (!$this->_authorizeUrl && $this->_siteUrl) {
return $this->_siteUrl . '/authorize';
}
return $this->_authorizeUrl;
}
/**
* Set request method
*
* @param string $method
* @return Zend_Oauth_Config
* @throws Zend_Oauth_Exception for invalid request methods
*/
public function setRequestMethod($method)
{
$method = strtoupper($method);
if (!in_array($method, array(
Zend_Oauth::GET,
Zend_Oauth::POST,
Zend_Oauth::PUT,
Zend_Oauth::DELETE,
Zend_Oauth::OPTIONS,
))
) {
#require_once 'Zend/Oauth/Exception.php';
throw new Zend_Oauth_Exception('Invalid method: ' . $method);
}
$this->_requestMethod = $method;
return $this;
}
/**
* Get request method
*
* @return string
*/
public function getRequestMethod()
{
return $this->_requestMethod;
}
/**
* Set RSA public key
*
* @param Zend_Crypt_Rsa_Key_Public $key
* @return Zend_Oauth_Config
*/
public function setRsaPublicKey(Zend_Crypt_Rsa_Key_Public $key)
{
$this->_rsaPublicKey = $key;
return $this;
}
/**
* Get RSA public key
*
* @return Zend_Crypt_Rsa_Key_Public
*/
public function getRsaPublicKey()
{
return $this->_rsaPublicKey;
}
/**
* Set RSA private key
*
* @param Zend_Crypt_Rsa_Key_Private $key
* @return Zend_Oauth_Config
*/
public function setRsaPrivateKey(Zend_Crypt_Rsa_Key_Private $key)
{
$this->_rsaPrivateKey = $key;
return $this;
}
/**
* Get RSA private key
*
* @return Zend_Crypt_Rsa_Key_Private
*/
public function getRsaPrivateKey()
{
return $this->_rsaPrivateKey;
}
/**
* Set OAuth token
*
* @param Zend_Oauth_Token $token
* @return Zend_Oauth_Config
*/
public function setToken(Zend_Oauth_Token $token)
{
$this->_token = $token;
return $this;
}
/**
* Get OAuth token
*
* @return Zend_Oauth_Token
*/
public function getToken()
{
return $this->_token;
}
/**
* Set OAuth realm
*
* @param string $realm
* @return Zend_Oauth_Config
*/
public function setRealm($realm)
{
$this->_realm = $realm;
return $this;
}
/**
* Get OAuth realm
*
* @return string
*/
public function getRealm()
{
return $this->_realm;
}
}