Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tkhamez/eve-sso-php
PHP library supporting EVE Online SSO v2.
https://github.com/tkhamez/eve-sso-php
authentication eve-online oauth2 php sso
Last synced: about 1 month ago
JSON representation
PHP library supporting EVE Online SSO v2.
- Host: GitHub
- URL: https://github.com/tkhamez/eve-sso-php
- Owner: tkhamez
- License: mit
- Created: 2022-04-23T13:05:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T17:00:10.000Z (about 1 month ago)
- Last Synced: 2024-06-02T18:50:49.777Z (about 1 month ago)
- Topics: authentication, eve-online, oauth2, php, sso
- Language: PHP
- Homepage:
- Size: 173 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-eve - EVE Online SSO - PHP package supporting EVE Online SSO v2. (Developer tools & libraries)
README
[](https://github.com/tkhamez/eve-sso-php/actions)
[](https://codeclimate.com/github/tkhamez/eve-sso-php/test_coverage)
# EVE Online SSO
PHP package supporting [EVE Online SSO v2](https://docs.esi.evetech.net/docs/sso/) (flow for web based applications)
including JWT signature verification.
## Install
To install the library via [Composer](http://getcomposer.org/), execute:
```shell
composer require tkhamez/eve-sso
```
## Example Usage
```php
// Initiate provider object
// (if you do not provide all optional URLs this will make a request to the metadata URL to
// get them).
try {
$provider = new Eve\Sso\AuthenticationProvider(
[
// required
'clientId' => 'your-EVE-app-client-ID',
'clientSecret' => 'your-EVE-app-secret-key',
'redirectUri' => 'https://your-callback.url',
// optional
'urlAuthorize' => 'https://login.eveonline.com/v2/oauth/authorize',
'urlAccessToken' => 'https://login.eveonline.com/v2/oauth/token',
'urlRevoke' => 'https://login.eveonline.com/v2/oauth/revoke',
'urlKeySet' => 'https://login.eveonline.com/oauth/jwks',
'issuer' => 'https://login.eveonline.com',
'urlMetadata' => 'https://login.eveonline.com/.well-known/oauth-authorization-server',
],
// Add all required scopes.
['esi-mail.read_mail.v1', 'esi-skills.read_skills.v1'],
// Optionally use your own HTTP client.
httpClient: new GuzzleHttp\Client(),
// Optionally add a logger to log exception that are caught from libraries
// (any class implementing Psr\Log\LoggerInterface, the example uses monolog/monolog
// which is not included in this package).
logger: new Monolog\Logger('SSO', [new Monolog\Handler\StreamHandler('/path/to/logfile')])
);
} catch (Exception $e) {
echo $e->getMessage();
}
// Optionally disable signature verification.
$provider->setSignatureVerification(false);
```
```php
// Login URL
session_start();
$_SESSION['state'] = $provider->generateState();
$loginUrl = $provider->buildLoginUrl($_SESSION['state']);
header("Location: $loginUrl");
```
```php
// Callback URL
session_start();
try {
$auth = $provider->validateAuthenticationV2($_GET['state'], $_SESSION['state'], $_GET['code']);
} catch (Exception $e) {
echo $e->getMessage();
}
// Store the token data somewhere
$refreshToken = $auth->getToken()->getRefreshToken();
$accessToken = $auth->getToken()->getToken();
$expires = $auth->getToken()->getExpires();
// ...
```
```php
// Refreshes access token, if necessary.
$existingToken = new League\OAuth2\Client\Token\AccessToken([
'refresh_token' => $refreshToken,
'access_token' => $accessToken,
'expires' => $expires,
]);
try {
$token = $provider->refreshAccessToken($existingToken);
} catch (Exception $e) {
echo $e->getMessage();
}
```
## Dev Env
```shell
docker build --tag eve-sso .
docker run -it --mount type=bind,source="$(pwd)",target=/app --workdir /app eve-sso /bin/sh
```