Google

import useBaseUrl from '@docusaurus/useBaseUrl'; import DefaultBehaviour from './_default-behaviour.md'; import OverrideIntro from './_override-intro.md'; import OverrideExampleIntro from './_override-example-intro.md'; import UsingAuthNote from './_using-auth-note.md'; import WaspFileStructureNote from './_wasp-file-structure-note.md'; import GetUserFieldsType from './_getuserfields-type.md'; import ApiReferenceIntro from './_api-reference-intro.md'; import UserSignupFieldsExplainer from '../_user-signup-fields-explainer.md'; import GoogleData from '../entities/_google-data.md'; import AccessingUserDataNote from '../_accessing-user-data-note.md'; import SocialLoginClientPages from './_social-login-client-pages.md';

Wasp supports Google Authentication out of the box. Google Auth is arguably the best external auth option, as most users on the web already have Google accounts.

Enabling it lets your users log in using their existing Google accounts, greatly simplifying the process and enhancing the user experience.

Let's walk through enabling Google authentication, explain some of the default settings, and show how to override them.

Setting up Google Auth

Enabling Google Authentication comes down to a series of steps:

1. Enabling Google authentication in the Wasp file.
2. Adding the User entity.
3. Creating a Google OAuth app.
4. Adding the necessary Routes and Pages
5. Using Auth UI components in our Pages.

1. Adding Google Auth to Your Wasp File

Let's start by properly configuring the Auth object:

app myApp {
  wasp: {
    version: "{latestWaspVersion}"
  },
  title: "My App",
  auth: {
    // 1. Specify the User entity (we'll define it next)
    // highlight-next-line
    userEntity: User,
    methods: {
      // 2. Enable Google Auth
      // highlight-next-line
      google: {}
    },
    onAuthFailedRedirectTo: "/login"
  },
}

userEntity is explained in the social auth overview.

2. Adding the User Entity

Let's now define the app.auth.userEntity entity in the schema.prisma file:

// 3. Define the user entity
model User {
  // highlight-next-line
  id Int @id @default(autoincrement())
  // Add your own fields below
  // ...
}

3. Creating a Google OAuth App

To use Google as an authentication method, you'll first need to create a Google project and provide Wasp with your client key and secret. Here's how you do it:

1. Create a Google Cloud Platform account if you do not already have one: https://cloud.google.com/

2. Create and configure a new Google project here: https://console.cloud.google.com/projectcreate

3. Search for Google Auth in the top bar (1), click on Google Auth Platform (2). Then click on Get Started (3).

4. Fill out you app information. For the Audience field, we will go with External. When you're done, click Create.

5. You should now be in the OAuth Overview page. Click on Create OAuth Client (1).

6. Fill out the form. These are the values for a typical Wasp application:

   #	Field	Value
   1	Application type	Web application
   2	Name	(your wasp app name)
   3	Authorized redirect URIs	http://localhost:3001/auth/google/callback

   :::note Once you know on which URL(s) your API server will be deployed, also add those URL(s) to the Authorized redirect URIs.
   For example: https://your-server-url.com/auth/google/callback :::

   Then click on Create (4).

7. You will see a box saying OAuth client created. Click on OK.

8. Click on the name of your newly-created app.

9. On the right-hand side, you will see your Client ID (1) and Client secret (2). Copy them somewhere safe, as you will need them for your app.

   :::info These are the credentials your app will use to authenticate with Google. Do not share them anywhere publicly, as anyone with these credentials can impersonate your app and access user data. :::

10. Click on Data Access (1) in the left-hand menu, then click on Add or remove scopes (2). You should select userinfo.profile (3), and optionally userinfo.email (4), or any other scopes you want to use. Remember to click Update and Save when done.

11. Go to Audience (1) in the left-hand menu, and add any test users you want (2). This is useful for testing your app before going live. You can add any email addresses you want to test with.

12. Finally, you can go to Branding (1) in the left-hand menu, and customize your app's branding in the Google login page. This is optional, but recommended if you want to make your app look more professional.

4. Adding Environment Variables

Add these environment variables to the .env.server file at the root of your project (take their values from the previous step):

GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret

5. Adding the Necessary Routes and Pages

Let's define the necessary authentication Routes and Pages.

Add the following code to your main.wasp file:

// ...

route LoginRoute { path: "/login", to: LoginPage }
page LoginPage {
  component: import { Login } from "@src/pages/auth"
}

We'll define the React components for these pages in the src/pages/auth.{jsx,tsx} file below.

6. Create the Client Pages

Conclusion

Yay, we've successfully set up Google Auth! 🎉

Running wasp db migrate-dev and wasp start should now give you a working app with authentication. To see how to protect specific pages (i.e., hide them from non-authenticated users), read the docs on using auth.

Default Behaviour

Add google: {} to the auth.methods dictionary to use it with default settings:

app myApp {
  wasp: {
    version: "{latestWaspVersion}"
  },
  title: "My App",
  auth: {
    userEntity: User,
    methods: {
      // highlight-next-line
      google: {}
    },
    onAuthFailedRedirectTo: "/login"
  },
}

Overrides

Data Received From Google

We are using Google's API and its /userinfo endpoint to fetch the user's data.

The data received from Google is an object which can contain the following fields:

[
  "name",
  "given_name",
  "family_name",
  "email",
  "email_verified",
  "aud",
  "exp",
  "iat",
  "iss",
  "locale",
  "picture",
  "sub"
]

The fields you receive depend on the scopes you request. The default scope is set to profile only. If you want to get the user's email, you need to specify the email scope in the configFn function.

Using the Data Received From Google

app myApp {
  wasp: {
    version: "{latestWaspVersion}"
  },
  title: "My App",
  auth: {
    userEntity: User,
    methods: {
      google: {
        // highlight-next-line
        configFn: import { getConfig } from "@src/auth/google",
        // highlight-next-line
        userSignupFields: import { userSignupFields } from "@src/auth/google"
      }
    },
    onAuthFailedRedirectTo: "/login"
  },
}

model User {
  id          Int    @id @default(autoincrement())
  username    String @unique
  displayName String
}

// ...

import { defineUserSignupFields } from 'wasp/server/auth'

export const userSignupFields = defineUserSignupFields({
  username: () => 'hardcoded-username',
  displayName: (data: any) => data.profile.name,
})

export function getConfig() {
  return {
    scopes: ['profile', 'email'],
  }
}

Using Auth

When you receive the user object on the client or the server, you'll be able to access the user's Google ID like this:

API Reference

app myApp {
  wasp: {
    version: "{latestWaspVersion}"
  },
  title: "My App",
  auth: {
    userEntity: User,
    methods: {
      google: {
        // highlight-next-line
        configFn: import { getConfig } from "@src/auth/google",
        // highlight-next-line
        userSignupFields: import { userSignupFields } from "@src/auth/google"
      }
    },
    onAuthFailedRedirectTo: "/login"
  },
}

The google dict has the following properties:

• configFn: ExtImport

  This function must return an object with the scopes for the OAuth provider.

  tsCopy

  export function getConfig() {
    return {
      scopes: ['profile', 'email'],
    }
  }
  

• userSignupFields: ExtImport

  <UserSignupFieldsExplainer />

  Read more about the userSignupFields function here.