web/versioned_docs/version-0.16/auth/social-auth/google.md
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';
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.
Enabling Google Authentication comes down to a series of steps:
User entity.Let's start by properly configuring the Auth object:
<Tabs groupId="js-ts"> <TabItem value="js" label="JavaScript"> ```wasp title="main.wasp" 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" }, } ``` </TabItem> <TabItem value="ts" label="TypeScript"> ```wasp title="main.wasp" 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" }, } ``` </TabItem> </Tabs>userEntity is explained in the social auth overview.
Let's now define the app.auth.userEntity entity in the schema.prisma file:
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:
Select what type of app you want, we will go with External.
Fill out applicable information on Page 1.
On Page 2, Scopes, you should select userinfo.profile. You can optionally search for other things, like email.
Add any test users you want on Page 3.
Select Create Credentials.
Select OAuth client ID.
Complete the form
Under Authorized redirect URIs, put in: http://localhost:3001/auth/google/callback
https://your-server-url.com/auth/google/callbackWhen you save, you can click the Edit icon and your credentials will be shown.
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
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.jsx"
}
```
route LoginRoute { path: "/login", to: LoginPage }
page LoginPage {
component: import { Login } from "@src/pages/auth.tsx"
}
```
We'll define the React components for these pages in the src/pages/auth.{jsx,tsx} file below.
:::info We are using Tailwind CSS to style the pages. Read more about how to add it here. :::
Let's now create a auth.{jsx,tsx} file in the src/pages.
It should have the following code:
export function Login() {
return (
<Layout>
<LoginForm />
</Layout>
)
}
// A layout component to center the content
export function Layout({ children }) {
return (
<div className="h-full w-full bg-white">
<div className="flex min-h-[75vh] min-w-full items-center justify-center">
<div className="h-full w-full max-w-sm bg-white p-5">
<div>{children}</div>
</div>
</div>
</div>
)
}
```
export function Login() {
return (
<Layout>
<LoginForm />
</Layout>
)
}
// A layout component to center the content
export function Layout({ children }: { children: React.ReactNode }) {
return (
<div className="h-full w-full bg-white">
<div className="flex min-h-[75vh] min-w-full items-center justify-center">
<div className="h-full w-full max-w-sm bg-white p-5">
<div>{children}</div>
</div>
</div>
</div>
)
}
```
:::info Auth UI Our pages use an automatically-generated Auth UI component. Read more about Auth UI components here. :::
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.
Add google: {} to the auth.methods dictionary to use it with default settings:
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.
```prisma title="schema.prisma"
model User {
id Int @id @default(autoincrement())
username String @unique
displayName String
}
// ...
```
```js title="src/auth/google.js"
export const userSignupFields = {
username: () => 'hardcoded-username',
displayName: (data) => data.profile.name,
}
export function getConfig() {
return {
scopes: ['profile', 'email'],
}
}
```
```prisma title="schema.prisma"
model User {
id Int @id @default(autoincrement())
username String @unique
displayName String
}
// ...
```
```ts title="src/auth/google.ts"
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'],
}
}
```
<GetUserFieldsType />
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:
The google dict has the following properties:
configFn: ExtImportThis function must return an object with the scopes for the OAuth provider.
<Tabs groupId="js-ts"> <TabItem value="js" label="JavaScript"> ```js title="src/auth/google.js" export function getConfig() { return { scopes: ['profile', 'email'], } } ``` </TabItem> <TabItem value="ts" label="TypeScript"> ```ts title="src/auth/google.ts" export function getConfig() { return { scopes: ['profile', 'email'], } } ``` </TabItem> </Tabs>userSignupFields: ExtImportRead more about the userSignupFields function here.