File: Twitter.php

package info (click to toggle)
simplesamlphp 1.19.7-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 42,920 kB
  • sloc: php: 202,044; javascript: 14,867; xml: 2,700; sh: 225; perl: 82; makefile: 70; python: 5
file content (178 lines) | stat: -rw-r--r-- 5,927 bytes parent folder | download | duplicates (3)
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
<?php

namespace SimpleSAML\Module\authtwitter\Auth\Source;

$default = dirname(dirname(dirname(dirname(dirname(__FILE__))))).'/oauth/libextinc/OAuth.php';
$travis = dirname(dirname(dirname(dirname(__FILE__)))).'/vendor/simplesamlphp/simplesamlphp/modules/oauth/libextinc/OAuth.php';

if (file_exists($default)) {
    require_once($default);
} else if (file_exists($travis)) {
    require_once($travis);
} else {
    // Probably codecov, but we can't raise an exception here or Travis will fail
}

/**
 * Authenticate using Twitter.
 *
 * @author Andreas Åkre Solberg, UNINETT AS.
 * @package SimpleSAMLphp
 */

class Twitter extends \SimpleSAML\Auth\Source
{
    /**
     * The string used to identify our states.
     */
    const STAGE_INIT = 'twitter:init';

    /**
     * The key of the AuthId field in the state.
     */
    const AUTHID = 'twitter:AuthId';

    /**
     * @var string
     */
    private $key;

    /**
     * @var string
     */
    private $secret;

    /**
     * @var bool
     */
    private $force_login;

    /**
     * @var bool
     */
    private $include_email;

    /**
     * Constructor for this authentication source.
     *
     * @param array $info  Information about this authentication source.
     * @param array $config  Configuration.
     */
    public function __construct($info, $config)
    {
        assert(is_array($info));
        assert(is_array($config));

        // Call the parent constructor first, as required by the interface
        parent::__construct($info, $config);

        $configObject = \SimpleSAML\Configuration::loadFromArray(
            $config,
            'authsources['.var_export($this->authId, true).']'
        );

        $this->key = $configObject->getString('key');
        $this->secret = $configObject->getString('secret');
        $this->force_login = $configObject->getBoolean('force_login', false);
        $this->include_email = $configObject->getBoolean('include_email', false);
    }

    /**
     * Log-in using Twitter platform
     *
     * @param array &$state  Information about the current authentication.
     * @return void
     */
    public function authenticate(&$state)
    {
        assert(is_array($state));

        // We are going to need the authId in order to retrieve this authentication source later
        $state[self::AUTHID] = $this->authId;

        $stateID = \SimpleSAML\Auth\State::saveState($state, self::STAGE_INIT);

        $consumer = new \SimpleSAML\Module\oauth\Consumer($this->key, $this->secret);
        // Get the request token
        $linkback = \SimpleSAML\Module::getModuleURL('authtwitter/linkback.php', ['AuthState' => $stateID]);
        $requestToken = $consumer->getRequestToken(
            'https://api.twitter.com/oauth/request_token',
            ['oauth_callback' => $linkback]
        );
        \SimpleSAML\Logger::debug("Got a request token from the OAuth service provider [".
            $requestToken->key."] with the secret [".$requestToken->secret."]");

        $state['authtwitter:authdata:requestToken'] = $requestToken;
        \SimpleSAML\Auth\State::saveState($state, self::STAGE_INIT);

        // Authorize the request token
        $url = 'https://api.twitter.com/oauth/authenticate';
        if ($this->force_login) {
            $url = \SimpleSAML\Utils\HTTP::addURLParameters($url, ['force_login' => 'true']);
        }
        $consumer->getAuthorizeRequest($url, $requestToken);
    }


    /**
     * @param array &$state
     * @return void
     */
    public function finalStep(&$state)
    {
        $requestToken = $state['authtwitter:authdata:requestToken'];
        $parameters = [];

        if (!isset($_REQUEST['oauth_token'])) {
            throw new \SimpleSAML\Error\BadRequest("Missing oauth_token parameter.");
        }
        if ($requestToken->key !== (string) $_REQUEST['oauth_token']) {
            throw new \SimpleSAML\Error\BadRequest("Invalid oauth_token parameter.");
        }

        if (!isset($_REQUEST['oauth_verifier'])) {
            throw new \SimpleSAML\Error\BadRequest("Missing oauth_verifier parameter.");
        }
        $parameters['oauth_verifier'] = (string) $_REQUEST['oauth_verifier'];

        $consumer = new \SimpleSAML\Module\oauth\Consumer($this->key, $this->secret);

        \SimpleSAML\Logger::debug("oauth: Using this request token [".
            $requestToken->key."] with the secret [".$requestToken->secret."]");

        // Replace the request token with an access token
        $accessToken = $consumer->getAccessToken(
            'https://api.twitter.com/oauth/access_token',
            $requestToken,
            $parameters
        );
        \SimpleSAML\Logger::debug("Got an access token from the OAuth service provider [".
            $accessToken->key."] with the secret [".$accessToken->secret."]");

        $verify_credentials_url = 'https://api.twitter.com/1.1/account/verify_credentials.json';
        if ($this->include_email) {
            $verify_credentials_url = $verify_credentials_url.'?include_email=true';
        }
        $userdata = $consumer->getUserInfo($verify_credentials_url, $accessToken);

        if (!isset($userdata['id_str']) || !isset($userdata['screen_name'])) {
            throw new \SimpleSAML\Error\AuthSource(
                $this->authId,
                'Authentication error: id_str and screen_name not set.'
            );
        }

        $attributes = [];
        foreach ($userdata as $key => $value) {
            if (is_string($value)) {
                $attributes['twitter.'.$key] = [(string) $value];
            }
        }

        $attributes['twitter_at_screen_name'] = ['@'.$userdata['screen_name']];
        $attributes['twitter_screen_n_realm'] = [$userdata['screen_name'].'@twitter.com'];
        $attributes['twitter_targetedID'] = ['http://twitter.com!'.$userdata['id_str']];

        $state['Attributes'] = $attributes;
    }
}