Skip to content

Latest commit

 

History

History
239 lines (156 loc) · 15.1 KB

README.md

File metadata and controls

239 lines (156 loc) · 15.1 KB
Raw

This library provides Apple authentication for iOS standalone apps in the managed and bare workflows. Beginning with iOS 13, any app that includes third-party authentication options must provide Apple authentication as an option in order to comply with App Store Review guidelines. Learn more about Apple authentication on the "Sign In with Apple" website.

Image of buttons

Installation

NPM: npm install @pontusab/react-native-apple-authentication

Yarn: yarn @pontusab/react-native-apple-authentication

Setup

  1. Enable the "Sign In with Apple" capability in your app. For bare projects, enable the capability in Xcode under "Signing & Capabilities" -- you'll need to be on Xcode 11 or later. For managed projects, set ios.usesAppleSignIn to true in app.json.
  2. Log into the Apple Developer Console, go to "Certificates, Identifiers, & Profiles" and then "Identifiers".
  3. You need to choose a primary app for the Apple Sign In configuration. This is the app whose icon will show up in the Apple Sign In system UI. If you have a set of related apps you might choose the "main" app as the primary, but most likely you'll want to just use the app you're working on now as the primary.
  4. In the list of identifiers, click on the one corresponding to your primary app. Enable the "Sign In with Apple" capability, click "Edit", and choose the "Enable as a primary App ID" option. Save the new configuration.
  5. If you chose a different app to be the primary, you'll also need to open up the configuration page for your current app, enable the "Sign In with Apple" capability, click "Edit" and choose the "Group with an existing primary App ID" option. Save this configuration as well.
  6. Finally, go to the "Keys" page and register a new key. Add the "Sign In with Apple" capability, and make sure to choose the correct primary app on the configuration screen.

Development and Testing

You can do limited testing of this library on the iOS simulator. However, not all methods will behave the same as on a device, so we highly recommend testing on a real device when possible while developing.

API

import * as AppleAuthentication from 'react-native-apple-authentication';

Methods

Components

Prop Types

Enum Types

Object Types

Errors

Methods

AppleAuthentication.isAvailableAsync()

Determine if the current device's operating system supports Apple authentication.

Returns

A promise that resolves to true if the system supports Apple authentication, and false otherwise.

AppleAuthentication.signInAsync(options)

Sends a request to the operating system to initiate the Apple authentication flow, which will present a modal to the user over your app and allow them to sign in.

You can request access to the user's full name and email address in this method, which allows you to personalize your UI for signed in users. However, users can deny access to either or both of these options at runtime. Additionally, you will only receive this information the first time users sign into your app, so you must store it for later use. Even if you request scopes every time a user signs into your app, and the user grants your app access, iOS will provide you with this information only upon the user's first successful sign-in.

Arguments

An optional AppleAuthenticationSignInOptions object with any of the following keys:

  • requestedScopes (AppleAuthenticationScope[]) - Array of user information scopes to which your app is requesting access. Note that the user can choose to deny your app access to any scope at the time of logging in. You will still need to handle null values for any scopes you request. Additionally, note that the requested scopes will only be provided to you the first time each user signs into your app; in subsequent requests they will be null.
  • state (string) - An arbitrary string that is returned unmodified in the corresponding credential after a successful authentication. This can be used to verify that the response was from the request you made and avoid replay attacks.

Returns

A promise that resolves to an AppleAuthenticationCredential object after a successful authentication, and rejects with ERR_CANCELED if the user cancels the sign-in operation.

AppleAuthentication.getCredentialStateAsync(user)

Queries the current state of a user credential, to determine if it is still valid or if it has been revoked.

Note: This method must be tested on a real device. On the iOS simulator it always throws an error.

Arguments

  • user (string) - The unique identifier for the user whose credential state you'd like to check. This should come from the user field of an AppleAuthenticationCredential object.

Returns

A promise that resolves to an AppleAuthenticationCredentialState value depending on the state of the credential.

Components

AppleAuthentication.AppleAuthenticationButton

This component displays the proprietary "Sign In with Apple" / "Continue with Apple" button on your screen. The App Store Guidelines require you to use this component to start the authentication process instead of a custom button. Limited customization of the button is available via the provided properties.

You should only attempt to render this if AppleAuthentication.isAvailableAsync() resolves to true. This component will render nothing if it is not available and you will get a warning in development mode.

The properties of this component extend from View; however, you should not attempt to set backgroundColor or borderRadius with the style property. This will not work and is against the App Store Guidelines. Instead, you should use the buttonStyle property to choose one of the predefined color styles and the cornerRadius property to change the border radius of the button.

AppleAuthentication.AppleAuthenticationButtonProps

  • onPress (function) - The method to call when the user presses the button. You should call AppleAuthentication.signInAsync in here.
  • buttonType (AppleAuthenticationButtonType) - The type of button text to display ("Sign In with Apple" vs. "Continue with Apple").
  • buttonStyle (AppleAuthenticationButtonStyle) - The Apple-defined color scheme to use to display the button.
  • cornerRadius (number) - The border radius to use when rendering the button. This works similarly to style.borderRadius in other Views.

Example

import * as AppleAuthentication from 'react-native-apple-authentication';

function YourComponent() {
  return (
    <AppleAuthentication.AppleAuthenticationButton
      buttonType={AppleAuthentication.AppleAuthenticationButtonType.SIGN_IN}
      buttonStyle={AppleAuthentication.AppleAuthenticationButtonStyle.BLACK}
      cornerRadius={5}
      onPress={() => {
        try {
          const credential = await AppleAuthentication.signInAsync({
            requestedScopes: [
              AppleAuthentication.AppleAuthenticationScope.FULL_NAME,
              AppleAuthentication.AppleAuthenticationScope.EMAIL,
            ],
          });
          // signed in
        } catch (e) {
          if (e.code === 'ERR_CANCELED') {
            // handle that the user canceled the sign-in flow
          } else {
            // handle other errors
          }
        }
      }}
    />
  );
}

Enum Types

AppleAuthentication.AppleAuthenticationButtonStyle

An enum whose values control which pre-defined color scheme to use when rendering an AppleAuthenticationButton.

  • AppleAuthenticationButtonStyle.WHITE - White button with black text
  • AppleAuthenticationButtonStyle.WHITE_OUTLINE - White button with a black outline and black text
  • AppleAuthenticationButtonStyle.BLACK - Black button with white text

AppleAuthentication.AppleAuthenticationButtonType

An enum whose values control which pre-defined text to use when rendering an AppleAuthenticationButton.

  • AppleAuthenticationButtonType.SIGN_IN - "Sign in with Apple"
  • AppleAuthenticationButtonType.CONTINUE - "Continue with Apple"

AppleAuthentication.AppleAuthenticationCredentialState

An enum whose values specify state of the credential when checked with AppleAuthentication.getCredentialStateAsync().

  • AppleAuthenticationCredentialState.REVOKED
  • AppleAuthenticationCredentialState.AUTHORIZED
  • AppleAuthenticationCredentialState.NOT_FOUND
  • AppleAuthenticationCredentialState.TRANSFERRED

AppleAuthentication.AppleAuthenticationScope

An enum whose values specify scopes you can request when calling AppleAuthentication.signInAsync().

  • AppleAuthenticationScope.FULL_NAME
  • AppleAuthenticationScope.EMAIL

AppleAuthentication.AppleAuthenticationUserDetectionStatus

An enum whose values specify the system's best guess for how likely the current user is a real person.

  • AppleAuthenticationUserDetectionStatus.UNSUPPORTED - The system does not support this determination and there is no data.
  • AppleAuthenticationUserDetectionStatus.UNKNOWN - The system has not determined whether the user might be a real person.
  • AppleAuthenticationUserDetectionStatus.LIKELY_REAL - The user appears to be a real person.

Object Types

AppleAuthentication.AppleAuthenticationCredential

The object type returned from a successful call to AppleAuthentication.signInAsync which contains all of the pertinent user and credential information.

  • user (string) - An identifier associated with the authenticated user. You can use this to check if the user is still authenticated later. This is stable and can be shared across apps released under the same development team. The same user will have a different identifier for apps released by other developers.
  • fullName (AppleAuthenticationFullName) - The user's name. May be null or contain null values if you didn't request the FULL_NAME scope, if the user denied access, or if this is not the first time the user has signed into your app.
  • email (string) - The user's email address. Might not be present if you didn't request the EMAIL scope. May also be null if this is not the first time the user has signed into your app. If the user chose to withhold their email address, this field will instead contain an obscured email address with an Apple domain.
  • realUserStatus (AppleAuthenticationUserDetectionStatus) - A value that indicates whether the user appears to the system to be a real person.
  • state (string) - An arbitrary string that your app provided as state in the request that generated the credential. Used to verify that the response was from the request you made. Can be used to avoid replay attacks. If you did not provide state when making the sign-in request, this field will be null.
  • identityToken (string) - A JSON Web Token (JWT) that securely communicates information about the user to your app.
  • authorizationCode (string) - A short-lived session token used by your app for proof of authorization when interacting with the app's server counterpart. Unlike user, this is ephemeral and will change each session.

AppleAuthentication.AppleAuthenticationFullName

An object representing the tokenized portions of the user's full name. Any of all of the fields may be null; only applicable fields that the user has allowed your app to access will be nonnull.

  • namePrefix (string)
  • givenName (string)
  • middleName (string)
  • familyName (string)
  • nameSuffix (string)
  • nickname (string)

AppleAuthentication.AppleAuthenticationSignInOptions

The options you can supply when making a call to AppleAuthentication.signInAsync(). None of these options are required.

  • requestedScopes (AppleAuthenticationScope[]) - The scope of personal information to which your app is requesting access. The user can choose to deny your app access to any scope at the time of logging in. Defaults to [] (no scopes).
  • state (string) - Data that's returned to you unmodified in the corresponding credential after a successful authentication. Used to verify that the response was from the request you made. Can be used to avoid replay attacks.

Error Codes

Code Description
ERR_APPLE_AUTHENTICATION_CREDENTIAL The request to get credential state failed. See the error message for additional specific information.
ERR_APPLE_AUTHENTICATION_INVALID_SCOPE An invalid AppleAuthenticationScope was passed in.
ERR_APPLE_AUTHENTICATION_REQUEST_FAILED The authentication request failed. See the error message for additional specific information.
ERR_APPLE_AUTHENTICATION_UNAVAILABLE Apple authentication is unavailable on the device.
ERR_CANCELED The user canceled the sign-in request from the system modal.