Rockets NestJS Apple Federated Authentication

Authenticate requests using Apple OAuth2

Project

Installation

yarn add @concepta/nestjs-auth-apple

Prerequisites

Before using this package, ensure you have:

1. Enrolled in the Apple Developer Program.
2. Familiarized yourself with Apple's "Sign in with Apple" documentation.
3. Created an App ID and Service ID in your Apple Developer Account.
4. Generated a private key for your Service ID in your Apple Developer Account.

Setup

For detailed setup instructions, refer to the following resources:

• What the Heck is Sign In with Apple? A comprehensive blog post explaining the feature and setup process.
• Apple Auth Setup Guide Step-by-step instructions for configuring Apple Sign In.

Environment Variables

To configure Apple authentication, you need to set the following environment variables:

• APPLE_CLIENT_ID: Your Apple Service ID (also known as the Services ID in Apple's Developer Portal). Typically in reverse domain name notation. Example: com.conceptatech.rockets

• APPLE_CALLBACK_URL: The OAuth Redirect URI for Apple authentication. Example: /auth/apple/callback

• APPLE_SCOPE: The requested scope(s) for Apple Sign In. Example: 'email'

• APPLE_TEAM_ID: Your Apple Developer Team ID. Found in the top right corner of the Apple Developer account page. Example: 'A1B2C3D4E5'

• APPLE_KEY_ID: The identifier for the private key on the Apple Developer Account page. Example: 'ABCDEF1234'

• APPLE_PRIVATE_KEY_LOCATION: The file path to your Apple private key (.p8 file). Example: './src/config/AuthKey.p8'

• APPLE_PRIVATE_KEY_STRING: The contents of your Apple private key as a string. Use this instead of APPLE_PRIVATE_KEY_LOCATION if you prefer to store the key directly in the environment. Example: '-----BEGIN PRIVATE KEY-----\nMIGTAgEA...\n-----END PRIVATE KEY-----'

Example .env file: