Server IP : 213.176.29.180 / Your IP : 18.224.64.51 Web Server : Apache System : Linux 213.176.29.180.hostiran.name 4.18.0-553.22.1.el8_10.x86_64 #1 SMP Tue Sep 24 05:16:59 EDT 2024 x86_64 User : webtaragh ( 1001) PHP Version : 7.4.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON Directory (0750) : /home/webtaragh/.cpan/../public_html/ |
[ Home ] | [ C0mmand ] | [ Upload File ] |
---|
oauth2-microsoft/CONTRIBUTING.md 0000644 00000003332 14736103417 0012211 0 ustar 00 # Contributing Contributions are **welcome** and will be fully **credited**. We accept contributions via Pull Requests on [Github](https://github.com/stevenmaguire/oauth2-microsoft). ## Pull Requests - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). - **Add tests!** - Your patch won't be accepted if it doesn't have tests. - **Document any change in behaviour** - Make sure the README and any other relevant documentation are kept up-to-date. - **Consider our release cycle** - We try to follow SemVer. Randomly breaking public APIs is not an option. - **Create topic branches** - Don't ask us to pull from your master branch. - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting. - **Ensure tests pass!** - Please run the tests (see below) before submitting your pull request, and make sure they pass. We won't accept a patch until all tests pass. - **Ensure no coding standards violations** - Please run PHP Code Sniffer using the PSR-2 standard (see below) before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails. ## Running Tests ``` bash $ ./vendor/bin/phpunit ``` ## Running PHP Code Sniffer ``` bash $ ./vendor/bin/phpcs src --standard=psr2 -sp ``` **Happy coding**! oauth2-microsoft/src/Provider/Microsoft.php 0000644 00000005223 14736103417 0015020 0 ustar 00 <?php namespace Stevenmaguire\OAuth2\Client\Provider; use GuzzleHttp\Psr7\Uri; use League\OAuth2\Client\Provider\AbstractProvider; use League\OAuth2\Client\Provider\Exception\IdentityProviderException; use League\OAuth2\Client\Token\AccessToken; use Psr\Http\Message\ResponseInterface; class Microsoft extends AbstractProvider { /** * Default scopes * * @var array */ public $defaultScopes = ['wl.basic', 'wl.emails']; /** * Base url for authorization. * * @var string */ protected $urlAuthorize = 'https://login.live.com/oauth20_authorize.srf'; /** * Base url for access token. * * @var string */ protected $urlAccessToken = 'https://login.live.com/oauth20_token.srf'; /** * Base url for resource owner. * * @var string */ protected $urlResourceOwnerDetails = 'https://apis.live.net/v5.0/me'; /** * Get authorization url to begin OAuth flow * * @return string */ public function getBaseAuthorizationUrl() { return $this->urlAuthorize; } /** * Get access token url to retrieve token * * @return string */ public function getBaseAccessTokenUrl(array $params) { return $this->urlAccessToken; } /** * Get default scopes * * @return array */ protected function getDefaultScopes() { return $this->defaultScopes; } /** * Check a provider response for errors. * * @throws IdentityProviderException * @param ResponseInterface $response * @return void */ protected function checkResponse(ResponseInterface $response, $data) { if (isset($data['error'])) { throw new IdentityProviderException( (isset($data['error']['message']) ? $data['error']['message'] : $response->getReasonPhrase()), $response->getStatusCode(), $response ); } } /** * Generate a user object from a successful user details request. * * @param array $response * @param AccessToken $token * @return MicrosoftResourceOwner */ protected function createResourceOwner(array $response, AccessToken $token) { return new MicrosoftResourceOwner($response); } /** * Get provider url to fetch user details * * @param AccessToken $token * * @return string */ public function getResourceOwnerDetailsUrl(AccessToken $token) { $uri = new Uri($this->urlResourceOwnerDetails); return (string) Uri::withQueryValue($uri, 'access_token', (string) $token); } } oauth2-microsoft/src/Provider/MicrosoftResourceOwner.php 0000644 00000003261 14736103417 0017543 0 ustar 00 <?php namespace Stevenmaguire\OAuth2\Client\Provider; use League\OAuth2\Client\Provider\ResourceOwnerInterface; class MicrosoftResourceOwner implements ResourceOwnerInterface { /** * Raw response * * @var array */ protected $response; /** * Creates new resource owner. * * @param array $response */ public function __construct(array $response = array()) { $this->response = $response; } /** * Get user id * * @return string|null */ public function getId() { return $this->response['id'] ?: null; } /** * Get user email * * @return string|null */ public function getEmail() { return $this->response['emails']['preferred'] ?: null; } /** * Get user firstname * * @return string|null */ public function getFirstname() { return $this->response['first_name'] ?: null; } /** * Get user lastname * * @return string|null */ public function getLastname() { return $this->response['last_name'] ?: null; } /** * Get user name * * @return string|null */ public function getName() { return $this->response['name'] ?: null; } /** * Get user urls * * @return string|null */ public function getUrls() { return isset($this->response['link']) ? $this->response['link'].'/cid-'.$this->getId() : null; } /** * Return all of the owner details available as an array. * * @return array */ public function toArray() { return $this->response; } } oauth2-microsoft/README.md 0000644 00000010717 14736103417 0011244 0 ustar 00 # Microsoft Provider for OAuth 2.0 Client [![Latest Version](https://img.shields.io/github/release/stevenmaguire/oauth2-microsoft.svg?style=flat-square)](https://github.com/stevenmaguire/oauth2-microsoft/releases) [![Build Status](https://img.shields.io/travis/stevenmaguire/oauth2-microsoft/master.svg?style=flat-square)](https://travis-ci.org/stevenmaguire/oauth2-microsoft) [![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/stevenmaguire/oauth2-microsoft.svg?style=flat-square)](https://scrutinizer-ci.com/g/stevenmaguire/oauth2-microsoft/code-structure) [![Quality Score](https://img.shields.io/scrutinizer/g/stevenmaguire/oauth2-microsoft.svg?style=flat-square)](https://scrutinizer-ci.com/g/stevenmaguire/oauth2-microsoft) [![Total Downloads](https://img.shields.io/packagist/dt/stevenmaguire/oauth2-microsoft.svg?style=flat-square)](https://packagist.org/packages/stevenmaguire/oauth2-microsoft) [![Software License](https://img.shields.io/packagist/l/stevenmaguire/oauth2-microsoft.svg?style=flat-square)](LICENSE.md) This package provides Microsoft OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client). ## Installation To install, use composer: ``` composer require stevenmaguire/oauth2-microsoft ``` ## Usage Usage is the same as The League's OAuth client, using `\Stevenmaguire\OAuth2\Client\Provider\Microsoft` as the provider. ### Authorization Code Flow ```php $provider = new Stevenmaguire\OAuth2\Client\Provider\Microsoft([ // Required 'clientId' => '{microsoft-client-id}', 'clientSecret' => '{microsoft-client-secret}', 'redirectUri' => 'https://example.com/callback-url', // Optional 'urlAuthorize' => 'https://login.windows.net/common/oauth2/authorize', 'urlAccessToken' => 'https://login.windows.net/common/oauth2/token', 'urlResourceOwnerDetails' => 'https://outlook.office.com/api/v1.0/me' ]); if (!isset($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['oauth2state'] = $provider->getState(); header('Location: '.$authUrl); exit; // Check given state against previously stored one to mitigate CSRF attack } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) { unset($_SESSION['oauth2state']); exit('Invalid state'); } else { // Try to get an access token (using the authorization code grant) $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); // Optional: Now you have a token you can look up a users profile data try { // We got an access token, let's now get the user's details $user = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $user->getFirstname()); } catch (Exception $e) { // Failed to get user details exit('Oh dear...'); } // Use this to interact with an API on the users behalf echo $token->getToken(); } ``` #### Managing Scopes and State When creating your Microsoft authorization URL, you can specify the state and scopes your application may authorize. ```php $options = [ 'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE', 'scope' => ['wl.basic', 'wl.signin'] // array or string ]; $authorizationUrl = $provider->getAuthorizationUrl($options); ``` If neither are defined, the provider will utilize internal defaults. At the time of authoring this documentation, the following scopes are available. ##### Core - wl.basic - wl.offline_access - wl.signin ##### Extended - wl.birthday - wl.calendars - wl.calendars_update - wl.contacts_birthday - wl.contacts_create - wl.contacts_calendars - wl.contacts_photos - wl.contacts_skydrive - wl.emails - wl.events_create - wl.imap - wl.phone_numbers - wl.photos - wl.postal_addresses - wl.skydrive - wl.skydrive_update - wl.work_profile - office.onenote_create ## Testing ``` bash $ ./vendor/bin/phpunit ``` ## Contributing Please see [CONTRIBUTING](https://github.com/stevenmaguire/oauth2-microsoft/blob/master/CONTRIBUTING.md) for details. ## Credits - [Steven Maguire](https://github.com/stevenmaguire) - [All Contributors](https://github.com/stevenmaguire/oauth2-microsoft/contributors) ## License The MIT License (MIT). Please see [License File](https://github.com/stevenmaguire/oauth2-microsoft/blob/master/LICENSE) for more information. oauth2-microsoft/CHANGELOG.md 0000644 00000002224 14736103417 0011570 0 ustar 00 # Changelog All Notable changes to `oauth2-microsoft` will be documented in this file ## 2.2.0 - 2017-06-07 ### Added - Nothing ### Deprecated - Nothing ### Fixed - Nothing ### Removed - Support for retrieving image urls. ### Security - Nothing ## 2.1.0 - 2017-06-04 ### Added - Support for custom authorization urls, previous URLs serve as default values. ### Deprecated - Nothing ### Fixed - Nothing ### Removed - Nothing ### Security - Nothing ## 2.0.0 - 2017-01-25 ### Added - PHP 7.1 Support ### Deprecated - Nothing ### Fixed - Nothing ### Removed - PHP 5.5 Support ### Security - Nothing ## 1.0.0 - 2017-01-25 Bump for base package parity ## 0.2.1 - 2015-11-12 ### Added - Nothing ### Deprecated - Nothing ### Fixed - Improved null checks in checkResponse method ### Removed - Nothing ### Security - Nothing ## 0.2.0 - 2015-08-20 ### Added - Upgrade to support version 1.0 release of core client ### Deprecated - Nothing ### Fixed - Nothing ### Removed - Nothing ### Security - Nothing ## 0.1.0 - 2015-03-21 ### Added - Initial release! ### Deprecated - Nothing ### Fixed - Nothing ### Removed - Nothing ### Security - Nothing oauth2-microsoft/LICENSE 0000644 00000002071 14736103417 0010764 0 ustar 00 The MIT License (MIT) Copyright (c) 2015 Steven Maguire Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.