Hogyan biztosíthatjuk a mikroszolgáltatásokat az AWS-en Cognito, API Gateway és Lambda használatával

Az autent kezelése fájdalmas. De a legtöbb alkalmazásnak hitelesítenie kell a felhasználókat, és ellenőrizniük kell, hogy milyen erőforrásokhoz férhetnek hozzá. Bár a mikroszolgáltatások egyre népszerűbbek, bonyolultabbá tehetik. Be kell, hogy biztosítsa mind a felhasználó akciók és interakciók közötti szolgáltatásokat.

Az AWS remek építőelemeket kínál a mikroszolgáltatások architektúrájához. De mint az IKEA bútorait, magának is össze kell állítania a darabokat. Ráadásul az utasítások nem túl jók.

Felépítünk egy egyszerű alkalmazást, és konfiguráljuk az AWS-t a felhasználó hitelesítésére és a mikroszolgáltatás biztonságára.

TL; DR (türelmetleneknek)

Működő bemutató: //auth-api-demo.firebaseapp.com/ (felhasználó: demouserjelszó:demoPASS123)

GitHub Repo : //github.com/csepulv/auth-api-demo

Alaphasználati eset / feltételezés: Az erőforrásoknak két csoportja van: a) azok, amelyeknek hitelesített felhasználóra van szükségük, és b) amelyek nem.

Majd használjuk

  • AWS Lambda, API Gateway és Cognito
  • Claudia.js (az API felépítéséhez)
  • Reagál (webes kliensünk számára)

Azok számára, akik a végéig olvasnak, van néhány finomság.

Most a részletekért.

Fogalmi alkalmazási modell

A bemutató alkalmazás a következő modellt valósítja meg.

  • A felhasználó bejelentkezik egy alkalmazásba, és hitelesítési tokent kap
  • Az AWS ezt a tokent használja a személyazonosság ellenőrzésére és a védett erőforrások felhasználói kéréseinek engedélyezésére
  • az App Gateway virtuális árkot hoz létre a felhasználók és az alkalmazás erőforrásai között

AWS Services

Ha Ön még nem ismeri az AWS-t, akkor ott van a hivatalos AWS Getting Started portál. Az Udemy-nek van egy ingyenes tanfolyama, az AWS Essentials.

Szüksége lesz egy AWS-fiókhoz való hozzáférésre. Feliratkozhat az AWS ingyenes szintjére.

AWS Lambda

Míg az EC2 az egyik legnépszerűbb AWS opció, úgy gondolom, hogy a Lambda jobban megfelel a mikroszolgáltatásoknak. Az EC2 példányok virtuális gépek. Ön felelős mindenért, az operációs rendszertől az összes futó szoftverig. A Lambda egy Funkció mint szolgáltatás modell. Nincs szerver kiépítés vagy telepítés; megírja a szolgáltatási logikáját.

További információkért olvassa el az AWS Lambda dokumentumait.

De van egy ránc a Lambdas-szal. Az alkalmazás felhasználói közvetlenül nem tudják elérni őket. A lambdáknak olyan triggerekre van szükségük, amelyek a Lambda függvényt hívják meg. Ez lehet sorban lévő üzenet, vagy esetünkben API-átjáró kérés.

AWS API átjáró

Az API-átjáró árkot biztosít az alkalmazásszolgáltatások körül. Naplózhatja a felhasználói tevékenységeket, hitelesítheti a kéréseket és kikényszerítheti a felhasználási házirendeket (például a sebességkorlátozás). (Az AWS API átjáró dokumentumai jó referencia.)

AWS Cognito

Az AWS Cognito egy felhasználókezelési, hitelesítési és beléptető szolgáltatás. Sajnos az összes szolgáltatás és konfiguráció időnként zavaró lehet. (Mintha a biztonság és a hitelesítés valaha is könnyű lenne.?) Az API-junk biztonságának biztosítására a Cognito alapvető elemeire összpontosítunk.

Alkalmazás és környezet beállítása

A bemutató alkalmazásunk receptje:

  1. Az AWS Cognito alkalmazásban hozzon létre egy felhasználói készletet (ügyfélalkalmazással) és egy összevont identitáskészletet.
  2. Az AWS API-átjáróban hozzon létre egy használati tervet és API-kulcsot
  3. A Claudia JS segítségével készítsen és telepítsen egy egyszerű AWS Lambda alapú API-t.
  4. Frissítse az AWS IAM szerepkört, hogy hitelesített felhasználók hozzáférést kapjanak védett API-módszerekhez
  5. Hozzon létre egyoldalas alkalmazást (SPA) a create-react-app. Az AWS Cognito programot fogja használni, és aláírt (és hitelesített) API-kéréseket küld

A részletes AWS-beállítás aws-setup.mda GitHub repo bemutatójában található. Kiemeljük a beállítás szempontjait, és elmagyarázzuk a dolgokat.

AWS Cognito

Felhasználói készlet, kliens alkalmazás és domain név

Létrehozunk egy felhasználói készletet az alapértelmezett értékekkel. Részletek és képernyőképek:

  • Felhasználói készlet
  • Kliens alkalmazás
  • Domain név

Federated Identity Pool

Kicsit zavaró lehet, hogy szükségünk van egy felhasználói készletre és egy összevont identitáskészletre is. Ashan Fernandónak elég jó magyarázata van ebben a bejegyzésben. Leegyszerűsítve:

  • A felhasználói medencék hozzáférést biztosítanak a felhasználók számára egy alkalmazáshoz. Ez olyan, mint az olyan szolgáltatások, mint az Auth0.
  • A Federated Identity Pool hozzáférést biztosít az AWS erőforrásokhoz.

By combining the two pools, our application can authenticate a user and AWS will assign temporary credentials. These credentials allow the user to access AWS resources. The IAM role, configured in the Identity Pool, specifies the privileges for the temporary credentials.

The detailed Federated Identity Pool setup is here.

AWS API Gateway

I suggest creating a usage plan for our API. While not a requirement, it is a good practice, as AWS costs can “run away” if you aren’t careful. We will create a Usage Plan, named api-auth-demo and set a throttle and burst rate, and a daily quota for API calls. We will also create an API key, which the web client application will use. (Full setup details are here.)

We’ve finished the bulk of our AWS setup. We will now write our Lambda functions and then build our React web application.

AWS Lambda and Claudia JS

We will write our Lambda functions using Node.js. Claudia.js will deploy our Lambdas and configure the API Gateway. (As a note, the Serverless framework provides similar functionality.)

We only need a simple API for our example. We’ll create two API methods (i.e. very simple microservices): one for authenticated users and one for guests.

We’ll use the Claudia API Builder, which lets multiple routes map to a single lambda. The routing mechanism is similar to routing in frameworks such as Express.js.

 const ApiBuilder = require("claudia-api-builder"); const api = new ApiBuilder(); api.get("/no-auth",request => { return {message: "Open for All!"}; }, { apiKeyRequired: true } ); api.get("/require-auth", request => { return {message: "You're past the velvet rope!"}; }, { apiKeyRequired: true, authorizationType: "AWS_IAM" } ); module.exports = api; view rawapi.js hosted with ❤ by GitHub

We’ll use the Claudia.js command line to deploy the API to AWS.

claudia create --region us-west-2 --api-module api --name auth-api-demo

NOTE: Any changes to api.js will need to be re-deployed. Useclaudia update...

API Keys and Auth

In api.js, {apiKeyRequired: true} indicates that API requests require an API key. {authorizationType: 'AWS_IAM'} configures the API Gateway to authorize using AWS IAM. The underlying authentication mechanism is not obvious. The AWS docs outline the approach, but a summary is:

  • when a user signs in, Cognito will issue tokens for temporary credentials (obtained via STS).
  • for protected resources, the application needs to sign requests using these credentials
  • AWS decodes and verifies the signature
  • if the signature is valid, the API Gateway dispatches the request

There are other authorization methods available. The Claudia.js docs outline how to specify other methods. (The corresponding AWS docs are here.)

AWS IAM Roles for Authenticated Users

We need to edit the privileges for the IAM roles for authenticated users. We need to allow invoking the API Gateway method we created.

We need the ARN of the API Gateway. Go to the API Gateway console and find the API Gateway resource/method.

  • Copy the ARN
  • Go to the IAM console and find the Authenticated role created during the Cognito Federated Identity Pool setup
  • add an Inline Policy as below
  • Specify the copied ARN for the API Gateway resource in the policy.

Authenticated users can now invoke our protected API methods.

Service to Service Access Control

The Cognito setup will allow a user to invoke an API method. But this method invocation is a trigger for a Lambda function. The Lambda function executes within the context of a different IAM role. It is no longer a direct user request, but an AWS service to service interaction. IAM roles provide access control for this interaction.

Claudia.JS created the IAM role for the Lambda function. (You can also manually create this role and specify its identifier to Claudia.JS via the --role parameter. Details are here.)

If our Lambda function needs access to other AWS resources, we will need to update the Lambda’s IAM role and provide these privileges. This might be an RDS database, for example.

AWS has always used IAM to configure service to service access control. It is a well developed and well-documented model. It will probably be your primary mechanism for access control between microservices (within AWS). There might be cases where you need to augment or replace it, but I would start with IAM.

We can now build the web application for our users.

React Web Application

I am going to build a React single page web application (SPA). A Vue.js or Angular application would work too. For the client application, there are two significant components: AWS Amplify and the aws4 module.

AWS Amplify provides easy integration with AWS Cognito. aws4 is a popular library for signing AWS requests using AWS Request Signatures Version 4. AWS used signed requests for protected resources (i.e. authorized user requests).

Returning to the web client, we’ll use create-react-app. I won't outline the steps, as they are well documented on the create-react-app home page, and there are numerous online tutorials. (I've even written a few. )

For authentication, we need to do some state management. The example application doesn’t use any framework, but in a real application I’d suggest Mobx (or Redux.)

In the demo application, auth-store.js manages the user authentication state. This consists of the user's authentication state and credentials. These are used to

  • render different components and styles for authenticated vs. guest user
  • sign requests for protected API methods

While AWS Amplify manages much of the AWS Cognito integration, there is some work for us to do.

Determining Auth State from AWS Amplify

AWS Amplify’s documentation is good in some areas and deficient in others. I suggest reading the Authentication section of the Amplify documentation. This describes theAuth component, which interacts with Cognito.

However, there are still some aspects that the documentation doesn’t clearly address. AWS Amplify doesn’t make it easy to know the authentication state. (A discussion of this complexity is here.) Amplify configures itself asynchronously, without a callback. But there is an aws-amplify class that can help.

The Hub class in the aws-amplify module behaves like an event emitter. We care about two events: configured and cognitoHostedUI.

After the AWS Amplify configures the Auth component, it emits the configured event. Our application can then inquire about the current user's authentication status. This is useful when our application is being loaded, for example.

While using the application, we need to know if the authentication state changes. There is a sign-in event, but it isn't the event we want, as our demo application uses OAuth and the Cognito Hosted UI. The sign-in event is used in a custom sign-in/up screen or when using the built-in Amplify React UI. For OAuth, Amplify dispatches the cognitoHostedUI event after a completed OAuth sign-in flow.

Signing Requests

The current user will have credentials issued by AWS Cognito. These contain an access id, a secret key, and a session key. These are available by calling Auth.currentCredentials() in aws-amplify. For API methods authorized by IAM, you need to sign the request using AWS V4 Request Signatures. Thankfully, the aws4 module handles the complexities of generating these signatures.

In api-client.js,

 import aws4 from "aws4"; const apiHost = process.env.REACT_APP_API_HOST; const apiKey = process.env.REACT_APP_API_KEY; const region = process.env.REACT_APP_REGION; export async function authenticatedCall(authStore) { const opts = { method: "GET", service: "execute-api", region: region, path: "/latest/require-auth", host: apiHost, headers: { "x-api-key": apiKey }, url: `//${apiHost}/latest/require-auth` }; const credentials = await authStore.getCredentials(); const { accessKeyId, secretAccessKey, sessionToken } = credentials; const request = aws4.sign(opts, { accessKeyId, secretAccessKey, sessionToken }); delete request.headers.Host; const response = await fetch(opts.url, { headers: request.headers }); if (response.ok) { return await response.json(); } else return { message: response.statusText }; } export async function noAuthCall(authStore) { const response = await fetch(`//${apiHost}/latest/no-auth`, { headers: { "x-api-key": apiKey } }); return await response.json(); } view rawapi-client.js hosted with ❤ by GitHub

Demo

We can finally run npm start and run the app! When we first arrive at the application, we are a guest (unauthenticated user). You can also go to //auth-api-demo.firebaseapp.com/ to try it out.

We can access unprotected methods.

But if we try to access a protected resource, it will fail.

But if we sign in, we can access the protected resources.

Click Sign In and use demouser with password of demoPASS123.

We can now click the Req. Auth button to access a protected API method.

Whew! We had to configure multiple services and digest a lot of information. But we now have an application that is a model for authenticating microservices on AWS.

Now What?

This article’s approach is “all-in” on AWS. This was a deliberate choice, to show how the various AWS pieces fit together to solve a common need, namely auth. There are alternatives to methods in this article, and I outline a few here.

And for those who stayed with me to the end, I have some parting gifts.

  • In the demo repo, there is a script for automating the AWS setup. Its README has the details for running it.
  • resources-cheatsheet.md has the specific links for relevant AWS, Claudia.js, etc. documentation.

Thanks for reading!