0.1.0-rc2 • Published 5 years ago

@exoshtw/apple-auth-backend v0.1.0-rc2

Weekly downloads
15
License
GPL-2.0
Repository
github
Last release
5 years ago

Apple auth for backend

Library for sign in with Apple to use from server-side.

Usage

import fs from 'fs';
import path from 'path';
import {getAuthToken} from '@exoshtw/node-apple-signin';

export function loginApple(code) {
    const response = await getAuthToken(code, {
        clientId: '....',
        teamId: '....',
        keyId: '...',
        key: fs.readFileSync(path.join(__dirname, 'private_key.p8')),
    });

    console.log(response);

    // {
    //   access_token: '...',
    //   token_type: 'Bearer',
    //   expires_in: 3600,
    //   refresh_token: '...',
    //   id_token: '{encoded_jwt_reponse}',
    //   data: { // <- decoded id_token
    //     iss: 'https://appleid.apple.com',
    //     aud: '...',
    //     exp: 1582046751,
    //     iat: 1582046151,
    //     sub: '...',
    //     at_hash: '...',
    //     email: '...',
    //     email_verified: 'true',
    //     auth_time: 1582046132
    //   }
    // }
}

API

{int} getTimestamp()

Get actual timestamp in int32 format.

{string} generateSecret(options)

Generate the JWT signed token for apple auth

Parameters

NameTypeArgumentDescription
optionsobjectOptions
options.timestampintoptionalTimestamp, autogenerated by default
options.expireintoptionalExpiration time of token
options.clientIdstringApple client id
options.teamIdstringApple team id
options.keyIdstringPrivate key id

{object} getAuthToken(code, options)

Get the auth token to signing with back code

Parameters

NameTypeArgumentDescription
codestringCode returned from client app
optionsobjectOptions
options.timestampintoptionalTimestamp, autogenerated by default
options.expireintoptionalExpiration time of token
options.clientIdstringApple client id
options.teamIdstringApple team id
options.keyIdstringPrivate key id

Motivation

There are other greats libraries (listed bellow) to use with node, but are focused on generating a sign in url and to work with a callback url.

This library is focused on working from the server-side, for example, to use Apple signin from mobile applications.

Other libraries