# apple-signin-auth-fix >  Apple signin for node. Latest version **1.2.2** (published 2021-03-31) · MIT license · 0 weekly downloads ## Install ```sh npm install apple-signin-auth-fix pnpm add apple-signin-auth-fix yarn add apple-signin-auth-fix bun add apple-signin-auth-fix ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.2 | | Published | 2021-03-31 | | First published | 2021-03-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 41.3 KB | | Known vulnerabilities | 0 (+3 in 1 direct dependencies) | | Install scripts | no | | Author | Ahmed Tarek | | Maintainers | bigdong89 | | Keywords | apple, signin, login, auth, authentication, node, jwt, es6, flow, types, typescript, node | ## Links - npm: https://www.npmjs.com/package/apple-signin-auth-fix - Repository: https://github.com/a-tokyo/apple-signin-auth - Homepage: https://github.com/a-tokyo/apple-signin-auth#readme - Issues: https://github.com/a-tokyo/apple-signin-auth/issues - npm.io page: https://npm.io/package/apple-signin-auth-fix ## Dependencies (3) - [node-rsa](https://npm.io/package/node-rsa.md) ^1.1.1 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0 - [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1 ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 1.2.2 (latest) — 2021-03-31 ## README # apple-signin-auth  Apple signin for Node.js. Follow @ahmad_tokyo ## Prerequisites 1. You should be enrolled in [Apple Developer Program](https://developer.apple.com/programs/). 2. Please have a look at [Apple documentation]( https://developer.apple.com/sign-in-with-apple/get-started/) related to "Sign in with Apple" feature. 3. You should create App ID and Service ID in your Apple Developer Account. 4. You should generate private key for your Service ID in your Apple Developer Account. ## Apple Signin Setup Deatiled confuguration instructions can be found at [blog post](https://medium.com/@artyomefremov/add-sign-in-with-apple-button-to-your-website-today-part-1-12ed1444623a?postPublishedType=initial) and [Apple docs](https://help.apple.com/developer-account/#/dev1c0e25352). ## Installation ```bash npm install --save apple-signin-auth ``` OR ```bash yarn add apple-signin-auth ``` ## Usage ### 1. Get authorization URL Start "Sign in with Apple" flow by redirecting user to the authorization URL. ```js import appleSignin from 'apple-signin-auth'; // OR const appleSignin = require('apple-signin-auth'); // OR import { getAuthorizationUrl } from 'apple-signin-auth'; const options = { clientID: 'com.company.app', // Apple Client ID redirectUri: 'http://localhost:3000/auth/apple/callback', // OPTIONAL state: 'state', // optional, An unguessable random string. It is primarily used to protect against CSRF attacks. responseMode: 'query' | 'fragment' | 'form_post', // Force set to form_post if scope includes 'email' scope: 'email' // optional }; const authorizationUrl = appleSignin.getAuthorizationUrl(options); ``` Alternatively, you can use [Sign In with Apple](https://developer.apple.com/documentation/signinwithapplejs) browser javascript library. ### 2. Get access token 2.1. Retrieve "code" query param from URL string when user is redirected to your site after successful sign in with Apple. Example: http://localhost:3000/auth/apple/callback?code=somecode&state=123. 2.2. Exchange retrieved "code" to user's access token. More detail can be found in [Apple docs](https://developer.apple.com/documentation/signinwithapplerestapi/generate_and_validate_tokens). ```js const clientSecret = appleSignin.getClientSecret({ clientID: 'com.company.app', // Apple Client ID teamId: 'teamId', // Apple Developer Team ID. privateKey: 'PRIVATE_KEY_STRING', // path to private key associated with your client ID. -- Can also be `privateKeyPath` string keyIdentifier: 'XXX' // identifier of the private key. }); const options = { clientID: 'com.company.app', // Apple Client ID redirectUri: 'http://localhost:3000/auth/apple/callback', // use the same value which you passed to authorisation URL. clientSecret: clientSecret }; try { const tokenResponse = await appleSignin.getAuthorizationToken(code, options); } catch (err) { console.error(err); } ``` Result of ```getAuthorizationToken``` command is a JSON object representing Apple's [TokenResponse](https://developer.apple.com/documentation/signinwithapplerestapi/tokenresponse): ```js { access_token: 'ACCESS_TOKEN', // A token used to access allowed data. token_type: 'Bearer', // It will always be Bearer. expires_in: 300, // The amount of time, in seconds, before the access token expires. refresh_token: 'REFRESH_TOKEN', // used to regenerate new access tokens. Store this token securely on your server. id_token: 'ID_TOKEN' // A JSON Web Token that contains the user’s identity information. } ``` ### 3. Verify token signature and get unique user's identifier ```js try { const { sub: userAppleId } = await appleSignin.verifyIdToken(tokenResponse.id_token, { // Optional Options for further verification - Full list can be found here https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback audience: 'com.company.app', // client id - can also be an array nonce: 'NONCE', // nonce // If you want to handle expiration on your own, or if you want the expired tokens decoded ignoreExpiration: true, // default is false }); } catch (err) { // Token is not verified console.error(err); } ``` ### 4. Refresh access token after expiration ```js const clientSecret = appleSignin.getClientSecret({ clientID: 'com.company.app', // Apple Client ID teamId: 'teamId', // Apple Developer Team ID. privateKeyPath: '/var/www/app/AuthKey_XXXXXXXXXX.p8', // path to private key associated with client ID. -- Can also be `privateKey` string keyIdentifier: 'XXXXXXXXXX', // identifier of the private key. - can be found here https://developer.apple.com/account/resources/authkeys/list // OPTIONAL expAfter: 15777000, // Duration after which to expire JWT }); const options = { clientID: 'com.company.app', // Apple Client ID clientSecret }; try { const { access_token } = appleSignin.refreshAuthorizationToken(refreshToken, options); } catch (err) { console.error(err); } ``` ### Extra API functions - _setFetch: `(fetchFn: function) => void` - Sets the fetch function, defaults to node-fetch. eg: appleSigninAuth._setFetch(fetchWithProxy); ## Extras - Handles apple public keys switching solving this issue https://forums.developer.apple.com/thread/129047 - Caches Apple's public keys and only refetches when needed - ES6 (Can be imported using `import appleSigning from 'apple-signin-auth/src'`) - Flow Types ## Contributing Pull requests are highly appreciated! For major changes, please open an issue first to discuss what you would like to change. ## Support Feel free to contact me directly with questions or consultancy requests. --- _Source: https://npm.io/package/apple-signin-auth-fix · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._