Every app needs authentication and authorization. Logto is an Auth0 alternative designed for modern apps and SaaS products.
In this article, we will go through the steps to quickly build the AWS SES sign-in experience (user authentication) with Express and Logto.
Prerequisites
- A running Logto instance. Check out the introduction page to get started.
- Basic knowledge of Express.
- A usable AWS SES account.
Create an application in Logto
In you browser, open a new tab and enter the link of Logto Admin Console.
Once the page is loaded, in the "Get Started" section click the View all
link to open the application framework list page.
Choose your application type
In the opening modal, scroll to the "Traditional web" section or filter all the available " Traditional web" frameworks using the quick filter checkboxes on the left.
Click the "Express" framework card to start creating your application.
Enter application name
Enter the application name, e.g., "Bookstore," and click "Create application."
🎉 Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application.
Integrate Logto SDK
- The sample project is available on our SDK repository.
Installation
Install Logto SDK via your favorite package manager:
- npm
- pnpm
- yarn
npm i @logto/express cookie-parser express-session
pnpm add @logto/express cookie-parser express-session
yarn add @logto/express cookie-parser express-session
Integration
Prepare configs and required middlewares
Prepare configuration for the Logto client:
import { LogtoExpressConfig } from '@logto/express';
const config: LogtoExpressConfig = {
appId: '<your-application-id>',
appSecret: '<your-application-secret>',
endpoint: '<your-logto-endpoint>', // E.g. http://localhost:3001
baseUrl: '<your-express-app-base-url>', // E.g. http://localhost:3000
};
The SDK requires express-session to be configured in prior.
import cookieParser from 'cookie-parser';
import session from 'express-session';
app.use(cookieParser());
app.use(
session({
secret: 'random_session_key', // Replace with your own secret
cookie: { maxAge: 14 * 24 * 60 * 60 * 1000 }, // In miliseconds
})
);
Configure redirect URIs
Before we dive into the details, here's a quick overview of the end-user experience. The sign-in process can be simplified as follows:
- Your app invokes the sign-in method.
- The user is redirected to the Logto sign-in page. For native apps, the system browser is opened.
- The user signs in and is redirected back to your app (configured as the redirect URI).
Regarding redirect-based sign-in
- This authentication process follows the OpenID Connect (OIDC) protocol, and Logto enforces strict security measures to protect user sign-in.
- If you have multiple apps, you can use the same identity provider (Logto). Once the user signs in to one app, Logto will automatically complete the sign-in process when the user accesses another app.
To learn more about the rationale and benefits of redirect-based sign-in, see Logto sign-in experience explained.
In the following code snippets, we assume your app is running on http://localhost:3000/
.
Configure redirect URIs
Switch to the application details page of Logto Console. Add a redirect URI http://localhost:3000/callback
.
Just like signing in, users should be redirected to Logto for signing out of the shared session. Once finished, it would be great to redirect the user back to your website. For example, add http://localhost:3000/
as the post sign-out redirect URI section.
Then click "Save" to save the changes.
Register routes
The SDK provides a helper function handleAuthRoutes
to register 3 routes:
/logto/sign-in
: Sign in with Logto./logto/sign-in-callback
: Handle sign-in callback./logto/sign-out
: Sign out with Logto.
Add the following code to your app:
import { handleAuthRoutes } from '@logto/express';
app.use(handleAuthRoutes(config));
Implement sign-in and sign-out
With the routes registered, now let's implement the sign-in and sign-out buttons in the home page. We need to redirect the user to the sign-in or sign-out route when needed. To help with this, use withLogto
to inject authentication status to req.user
.
import { withLogto } from '@logto/express';
app.get('/', withLogto(config), (req, res) => {
res.setHeader('content-type', 'text/html');
if (req.user.isAuthenticated) {
res.end(`<div>Hello ${req.user.claims?.sub}, <a href="/logto/sign-out">Sign Out</a></div>`);
} else {
res.end('<div><a href="/logto/sign-in">Sign In</a></div>');
}
});
Checkpoint: Test your application
Now, you can test your application:
- Run your application, you will see the sign-in button.
- Click the sign-in button, the SDK will init the sign-in process and redirect you to the Logto sign-in page.
- After you signed in, you will be redirected back to your application and see the sign-out button.
- Click the sign-out button to clear local storage and sign out.
Add AWS SES connector
To add or change Email connector, go to the "Connector" tab in the Admin Console, then click on "Email and SMS connectors". From there, click "Set up" or go to detail page and click "Change Email connector".
In the openning modal, select "AWS SES" and click "Next".
On the next page, you will see a two-column layout with the README content on the left and configuration on the right.
Feel free to follow the README file in place or read the following section to complete the configuration process. If you follow the in-place guide, you can skip the next section.
Set up AWS SES email connector
Configure a mail service in the AWS service console
Amazon SES is a cloud email service provider that can integrate into any application for bulk email sending.
Logto core calls the Amazon Simple Email Service APIs via this connector, with the help of which Logto end-users can register and sign in to their Logto account via email verification code.
💡 Tip
You can skip some sections if you have already finished.
Register AWS account
Go to AWS and register an account.
Create a identity
- Go to
Amazon Simple Email Service
Console - Create an identity, choose one of the following options
- Create a domain
- Create an email address
Configuration of the connector
- Click your username in the upper right corner of the Amazon console to enter
Security Credentials
. If you don't have one, create anAccessKey
and save it carefully. - Complete the settings of the
Amazon Simple Email Service
connector:- Use the
AccessKey ID
andAccessKey Secret
obtained in step 1 to fill inaccessKeyId
andaccessKeySecret
respectively. region
: Fill in theregion
field with the region of the identity you use to send mail.emailAddress
: The email address you use to send mail, in the format ofLogto<[email protected]>
or<[email protected]>
- Use the
the following parameters are optional; parameters description can be found in the AWS SES API documentation.
feedbackForwardingEmailAddress
feedbackForwardingEmailAddressIdentityArn
configurationSetName
Test the Amazon SES connector
You can type in an email address and click on "Send" to see whether the settings work before "Save and Done".
That's it. Don't forget to enable connector in sign-in experience.
Configure types
Name | Type |
---|---|
accessKeyId | string |
accessKeySecret | string |
region | string |
emailAddress | string (OPTIONAL) |
emailAddressIdentityArn | string (OPTIONAL) |
feedbackForwardingEmailAddress | string (OPTIONAL) |
feedbackForwardingEmailAddressIdentityArn | string (OPTIONAL) |
configurationSetName | string (OPTIONAL) |
templates | Template[] |
Template Properties | Type | Enum values |
---|---|---|
subject | string | N/A |
content | string | N/A |
usageType | enum string | 'Register' | 'SignIn' | 'ForgotPassword' | 'Generic' |
Save your configuration
Double check you have filled out necessary values in the Logto connector configuration area. Click "Save and Done" (or "Save changes") and the AWS SES connector should be available now.
Enable AWS SES connector in Sign-in Experience
Switch to the "Sign-in experience" tab, then click the "Sign-up and sign-in" tab.
If it's the first time you enter the tab, you will see a quick introduction about Sign-in Experience and its basic configuration.
Select "Email address" or "Email address or phone number" for the "Sign-up identifier" to provide sign-up for Email passwordless sign-in, which may increase your conversion rate.
Finally, click "Save changes" on the bottom right corner.
Testing and Validation
Return to your Express app. You should now be able to sign in with AWS SES. Enjoy!
Further readings
Protect your API For native and single page apps, you'll need to call one or more API endpoints to retrieve and update data.
Learn more about identifying who's who and keeping your API secure.
User management We know you care about user management and activities, as we also do.
Learn more about how to know your users and see the figures like DAU and MAU graphically.
Localization From one regional business to a global corporate, the willingness to offer the best user experience won't change.
You can change current language phrases or add a new language without friction.
Customer IAM series Our serial blog posts about Customer (or Consumer) Identity and Access Management, from 101 to advanced topics and beyond.