Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/XboxReplay/xboxlive-auth
A light but advanced Xbox Live authentication module with OAuth2.0 and Electron support.
https://github.com/XboxReplay/xboxlive-auth
authentication electron live nodejs oauth2 typescript xbox xboxlive
Last synced: 3 months ago
JSON representation
A light but advanced Xbox Live authentication module with OAuth2.0 and Electron support.
- Host: GitHub
- URL: https://github.com/XboxReplay/xboxlive-auth
- Owner: XboxReplay
- License: mit
- Created: 2019-01-29T21:47:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T08:36:18.000Z (over 1 year ago)
- Last Synced: 2024-08-04T12:02:40.315Z (3 months ago)
- Topics: authentication, electron, live, nodejs, oauth2, typescript, xbox, xboxlive
- Language: TypeScript
- Homepage: https://www.xboxreplay.net/
- Size: 301 KB
- Stars: 92
- Watchers: 8
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- jimsghstars - XboxReplay/xboxlive-auth - A light but advanced Xbox Live authentication module with OAuth2.0 and Electron support. (TypeScript)
README
# @xboxreplay/xboxlive-auth
A light but advanced Xbox Live authentication module with [OAuth2.0](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/02-Custom_Azure_Application.md) and [Electron](https://github.com/XboxReplay/xboxlive-auth/blob/master/examples/electron-app) support.
## Warning
Due to security reasons ([CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for instance), this library has been designed to only run on a **node.js** environment.
## Breaking Changes
A lot of breaking changes have been made since the latest **3.3.3** release. Please make sure to take a look and follow each step from the [authenticate](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md) documentation.
## Installation
```shell
$ npm install @xboxreplay/xboxlive-auth
```
## Usage Example
```javascript
import { authenticate } from '@xboxreplay/xboxlive-auth';
authenticate('[email protected]', '*********')
.then(console.info)
.catch(console.error);
```
##### Sample Response
```javascript
{
"xuid": "2584878536129841", // May be null based on the specified "RelyingParty"
"user_hash": "3218841136841218711",
"xsts_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"display_claims": { // May vary based on the specified "RelyingParty"
"gtg": "Zeny IC",
"xid": "2584878536129841",
"uhs": "3218841136841218711",
"agg": "Adult",
"usr": "234",
"utr": "190",
"prv": "185 186 187 188 191 192 ..."
},
"expires_on": "2021-04-13T05:43:32.6275675Z"
}
```
## Documentation
- [Basic authentication](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md)
- [Use a custom Azure Application (OAuth2.0)](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/02-Custom_Azure_Application.md)
- [Experimental methods, such as "deviceToken" generation](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/03-Experimental.md)
- [What's a RelyingParty and how to use it](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/04-RelyingParty.md)
- [Available methods in this library](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/05-Methods.md)
- [Known issues and possible workarounds](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/06-Known_Issues.md)
- [How to deal with unauthorized "AgeGroup" authentication](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/07-Detect_Unauthorized_AgeGroup.md)
## Available Examples
- [Electron App](https://github.com/XboxReplay/xboxlive-auth/blob/master/examples/electron-app)
## How to interact with the Xbox Live API?
The best way to interact with the API is to use our [@xboxreplay/xboxlive-auth](https://github.com/XboxReplay/xboxlive-api) module. That said, a cURL example is available below and can be replicated using `axios` or another HTTP client for node.js.
##### Example
```shell
$ curl 'https://profile.xboxlive.com/users/gt(Major%20Nelson)/profile/settings?settings=Gamerscore' \
-H 'Authorization: XBL3.0 x={userHash};{XSTSToken}' \
-H 'x-xbl-contract-version: 2'
```
## What about 2FA (Two-factor authentication)?
Exposed `authenticate` and `authenticateWithUserCredentials` methods can not deal with 2FA but a workaround may be possible using the `authenticateWithUserRefreshToken` one. Please take a look at [authenticate ](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md) documentation. Additional improvements regarding this issue are not planned.
## Known Issues
Please refer to the [dedicated documention](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/06-Known_Issues.md).
## Licence
MIT