xal-node

xal-node: Typescript implementation for Xbox Authentication Library (XAL)

Installing xal-node

You can install the project with npm. In the project directory, run:

$ npm install xal-node

Building xal-node

Once the repository has been cloned you can run the command below to build the project:

$ npm run build

CLI

You can install the xbox-auth cli app using the instructions below:

$ npm install -g xal-node

Once installed make sure the npm path is properly set. You should be able to run xbox-auth to start the program.

Available commands

| Command | Description | |---------|-------------| | xbox-auth auth | Runs the authentication flow and provides an URL to login to. | | xbox-auth show | Shows the current status of the tokens and if they are expired or not. | | xbox-auth refresh | Refreshes the current stored tokens to new up to date tokens without running the full flow again. | | xbox-auth tokens | Fetches all tokens for use with xCloud and xHome | | xbox-auth logout | Removes the current stored tokens |

Tokens

The tokens are stored in the current working directory in the file .xbox.tokens.json. In this file you will have 3 directories: userToken, sisuToken and jwtKeys. The userToken and jwtKeys are important. Those are unique and allows us to refresh the tokens once they are expired. The sisuToken can always be renewed using the userToken and jwtKeys but we store them because it makes retrieving other tokens easier.

API examples

Check out src/bin/auth.ts for a good example. This file provides a quite easy to read example on how to authenticate, retrieve tokens and check the status.

Load the XAL library and Tokenstore:

this._tokenStore = new TokenStore()
this._tokenStore.load('.xbox.tokens.json') // File will be saved in the current working directory

this._xal = new Xal(this._tokenStore)

To authenticate:

this._xal.getRedirectUri().then((redirect) => {
    console.log('redirect', redirect)

    // Perform authentication in a web browser and catch the redirect uri. You can pass the redirect uri directly into the function.

    this._xal.authenticateUser(this._tokenStore, redirect, redirectUri).then((result) => {
        console.log('Authentication result:', result)
    })

    // Alternatively if you want to extract the code and state yourself, you can do that too and pass the code and state.
    const code = '<extracted code from uri>'
    const state = '<extracted state from uri>'

    this._xal.authenticateUserUsingCode(this._tokenStore, redirect, code, state).then((result) => {
        console.log('Authentication result:', result)
    })
}).catch((err) => {
    console.error(err)
})

To refresh the user token without user interaction:

this._xal.refreshTokens(this._tokenStore).then((tokens) => {
    console.log('tokens', tokens)
}).catch((err) => {
    if(err instanceof TokenRefreshError) {
        console.log('Failed to refresh tokens. Please authenticate again. Error details:', err)
    } else {
        console.error('refreshTokens Error:', err)
    }
})

Retrieve MSAL token:

this._xal.getMsalToken(this._tokenStore).then((msalToken) => {
    console.log('msalToken', msalToken)
}).catch((err) => {
    console.error(err)
})

Retrieve web token for interaction with the web api's:

this._xal.getWebToken(this._tokenStore).then((webToken) => {
    console.log('webToken', webToken)
}).catch((err) => {
    console.error(err)
})

Retrieve the xCloud and xHome streaming tokens:

this._xal.getStreamingToken(this._tokenStore).then((streamingTokens) => {
    console.log('streamingTokens', streamingTokens)
}).catch((err) => {
    console.error(err)
})

Other AppId and titleId's

It is possible to authenticate to different services using this library as well. Not all calls are supported but the authentication part is quite general. You can override the titleId like below:

const xal = xallib.Xal()
xal._app = {
    AppId: '<appId>',
    TitleId: '<titleId>',
    RedirectUri: '<redirectUri>',
}

Credits

Big thanks to @tuxuser and Team OpenXbox for creating the xal-rs library and giving the inspiration to port this over to Typescript