はじめに
この記事はAuth0のハンズオンラボでAuth0 Identity Labsを元に作成しています。Node.js + Express.jsで作成されたSample ApplicationとAPIを利用して、Auth0から払い出された認可情報を元にApplicationからAPIを呼び出します。Auth0ラボ - その1 : Web Sign-Inが完了していることが前提となっているため、未だの方はこちらからお試しお願いします。
検証環境
- OS :
macOS Catalina 10.15.2 - node :
10.15.3 - npm :
6.13.2 - Git :
2.23.0
ラボ
Part1
Part1ではApplicationからAccess Tokenを使ってAPIを呼び出すようにします。Git Repoをローカルにクローンします。
$ git clone https://github.com/auth0/identity-102-exercises.git
$cd identity-102-exercises/lab-02/begin
$lsapi webapp
apiディレクトリに移動してNode.jsのパッケージをインストール、環境変数定義ファイルを作成します。
$pwd~/identity-102-exercises/lab-02/begin/api
$ npm install$cp .env-sample .env
webappディレクトリに移動してNode.jsのパッケージをインストール、環境変数定義ファイルを作成します。
$pwd~/identity-102-exercises/lab-02/begin/webapp
$ npm install$cp .env-sample .env
api, webappを起動してChromeでhttp://localhost:3000にアクセスします。任意のユーザでSign-upして"Expenses"をクリックするとAPIが呼び出されて経費情報が表示されます。
この時点ではAPIは認可情報を元に保護されていないため、誰でもアクセスできてしまいます。後続の手順で認可情報を含むトークン(Access Token)でAPIにアクセスできるように修正します。
$pwd~/identity-102-exercises/lab-02/begin/api
$ npm start &
$cd ../webapp
$ npm start &
webapp/server.jsを修正してAuth0からAccess Tokenを受け取るようにします。以下、修正後のコードです。
"response_type: 'code id_token'"を指定することで、Expressミドルウェアが認可コードを元にAccess TokenをApplicationに払い出します。"audience", "scope"はアクセス対象のAPI/ScopeをExpressミドルウェアに渡しています。
require('dotenv').config();constexpress=require('express');consthttp=require('http');constmorgan=require('morgan');constsession=require('cookie-session');constrequest=require('request-promise');const{auth,requiresAuth}=require('express-openid-connect');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.set('view engine','ejs');app.use(morgan('combined'));app.use(session({name:'identity102-lab-02',secret:process.env.COOKIE_SECRET,}));app.use(express.urlencoded({extended:false}));/* 以下をコメントアウト
app.use(auth({
required: false,
auth0Logout: true
}));
*/// 下記を9行を追加app.use(auth({required:false,auth0Logout:true,authorizationParams:{response_type:'code id_token',audience:process.env.API_AUDIENCE,scope:'openid profile email read:reports'}}));app.get('/',(req,res)=>{res.render('home',{user:req.openid&&req.openid.user});});app.get('/user',requiresAuth(),(req,res)=>{res.render('user',{user:req.openid&&req.openid.user});});app.get('/expenses',requiresAuth(),async(req,res,next)=>{try{constexpenses=awaitrequest(process.env.API_URL,{json:true});res.render('expenses',{user:req.openid&&req.openid.user,expenses,});}catch(err){next(err);}});app.get('/logout',(req,res)=>{req.session=null;res.redirect('/');});app.use((err,req,res,next)=>{console.error(err.stack);res.status(500).send(err);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});webapp/server.jsを修正してAuth0から払い出されたAccess Tokenを使ってAPIにアクセスできるようにします。以下、修正後のコードです。
これによって、Applicationにログインしたユーザに割り当てられた認可情報を持ったAccess Tokenを使って、ユーザの代わりにApplicationがAPIを呼び出せるようになります。
require('dotenv').config();constexpress=require('express');consthttp=require('http');constmorgan=require('morgan');constsession=require('cookie-session');constrequest=require('request-promise');const{auth,requiresAuth}=require('express-openid-connect');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.set('view engine','ejs');app.use(morgan('combined'));app.use(session({name:'identity102-lab-02',secret:process.env.COOKIE_SECRET,}));app.use(express.urlencoded({extended:false}));app.use(auth({required:false,auth0Logout:true,authorizationParams:{response_type:'code id_token',audience:process.env.API_AUDIENCE,scope:'openid profile email read:reports'}}));app.get('/',(req,res)=>{res.render('home',{user:req.openid&&req.openid.user});});app.get('/user',requiresAuth(),(req,res)=>{res.render('user',{user:req.openid&&req.openid.user});});app.get('/expenses',requiresAuth(),async(req,res,next)=>{try{/* 以下をコメントアウト
const expenses = await request(process.env.API_URL, {
json: true
});
*/// 以下5行を追加consttokenSet=req.openid.tokens;constexpenses=awaitrequest(process.env.API_URL,{headers:{authorization:"Bearer "+tokenSet.access_token},json:true});res.render('expenses',{user:req.openid&&req.openid.user,expenses,});}catch(err){next(err);}});app.get('/logout',(req,res)=>{req.session=null;res.redirect('/');});app.use((err,req,res,next)=>{console.error(err.stack);res.status(500).send(err);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});webapp/.envを修正してAPIの識別子とApplicationのSecretを追加します。以下、修正後の.envです。
この時点でAPIはAuth0に登録されていないため識別子は任意で構いません。Part2でAPIをAuth0に登録する際に必要となるため控えておいて下さい。ApplicationのSecretはAuth0 Dashboardの"Applications"->"その1で作成したApplication"->"Settings"から確認できます。
ISSUER_BASE_URL=https://kiriko.auth0.com
CLIENT_ID=rJbxtul1gfExXU9K5610LgBR4SpF2d4R
API_URL=http://localhost:3001
BASE_URL=http://localhost:3000
PORT=3000
COOKIE_SECRET=xOTLraNhuwMkwpxltUoKiOPjJyPtvYvSHz9EbsIQG7w
API_AUDIENCE=https://expenses-api
CLIENT_SECRET=xxxx
Chromeに戻りログアウト後、再度ログインを押します。"message": "access_denied (Service not found: https://expenses-api)"が表示されれば成功です。
この時点でAPIはAuth0に登録されていないためエラーになります。
Part2
Part2ではAPIをAuth0に登録してAuth0がAccess Tokenを払い出せるようにします。Auth0 Dashboardの左ペイン"APIs"をクリック、右上の"CREATE API"を押します。
"Name"に任意の名前を入力し、"Identifier"に"https://expenses-api"を入力して"CREATE"を押します。
IdentifierはPar1で.envに指定した識別子と同一である必要があります。
"Permissions"タブをクリック、"Define all the permissionsxxx"に"read:reports"を、"Description"に任意の説明文を入力して"ADD"を押します。
書式はOAuth2.0で規定されているxxxx:xxxxに従う必要があります。
ターミナルに戻りwebapp, apiを再起動してChromeからhttp://localhost:3000にアクセス、任意のユーザでログイン後、コンセント画面が表示されれば成功です。
Applicationが認可サーバが管理しているAPIにアクセスしようとしていますがよろしいですか？とリソースオーナーであるユーザに確認しています。
$pwd~/identity-102-exercises/lab-02/begin/api
$ npm start &
$cd ../webapp
$ npm start &
Chromeから直接API(http://localhost:3001)にアクセスして見ます。下記のメッセージが表示されます。
この時点では、APIがAccess Tokenに含まれているScopeをチェックしていないためアクセスできてしまいます。
[{"date":"2019-12-25T03:02:25.637Z","description":"Pizza for a Coding Dojo session.","value":102},{"date":"2019-12-25T03:02:25.637Z","description":"Coffee for a Coding Dojo session.","value":42}]APIディレクトリでexpress-oauth2-bearerパッケージをインストールします。
このパッケージでApplicationから送信されてくるリクエストに含まれるAccess Tokenのチェックを行います。
$pwd~/identity-102-exercises/lab-02/begin/api
$ npm install express-oauth2-bearer
api/api-server.jsを修正してexpress-oauth2-bearerを読み込みます。以下、修正後のコードです。
require('dotenv').config();// 以下1行を追加const{auth,requiredScopes}=require('express-oauth2-bearer');constexpress=require('express');consthttp=require('http');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.get('/',(req,res)=>{res.send([{date:newDate(),description:'Pizza for a Coding Dojo session.',value:102,},{date:newDate(),description:'Coffee for a Coding Dojo session.',value:42,}]);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});api/api-server.jsを修正してExpressミドルウェアの認証処理を追加します。以下、修正後のコードです。
require('dotenv').config();const{auth,requiredScopes}=require('express-oauth2-bearer');constexpress=require('express');consthttp=require('http');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();// 以下1行を追加app.use(auth());app.get('/',(req,res)=>{res.send([{date:newDate(),description:'Pizza for a Coding Dojo session.',value:102,},{date:newDate(),description:'Coffee for a Coding Dojo session.',value:42,}]);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});api/api-server.jsを修正して、End Pointに送信されてくるAccess Tokenをチェックするようにします。以下、修正後のコードです。
これ以降、End Pointに送信されてくるAccess Tokenは必ずチェックされ、有効期限が切れている、Scopeが合っていない等の不正がある場合はエラーが返ってくるようになります。
require('dotenv').config();const{auth,requiredScopes}=require('express-oauth2-bearer');constexpress=require('express');consthttp=require('http');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.use(auth());// 以下をコメントアウト// app.get('/', (req, res) => {// 以下1行を追加app.get('/',requiredScopes('read:reports'),(req,res)=>{res.send([{date:newDate(),description:'Pizza for a Coding Dojo session.',value:102,},{date:newDate(),description:'Coffee for a Coding Dojo session.',value:42,}]);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});api/.envのISSUER_BASE_URLをAuth0のテナントドメイン名に修正します。
PORT=3001
ISSUER_BASE_URL=https://kiriko.auth0.com
ALLOWED_AUDIENCES=https://expenses-api
ターミナルに戻りwebapp, apiを再起動してChromeからhttp://localhost:3000にアクセス、任意のユーザでログイン後、APIにアクセスできることを確認します。Chromeからダイレクトにhttp://localhost:3001にアクセスします。以下のエラーが返ってくれば成功です。
Access Tokenがリクエストに含まれていないためエラーになります。
UnauthorizedError: bearer token is missing
at Object.createInvalidTokenError (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express-oauth2-bearer/lib/errors.js:15:12)
at /Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express-oauth2-bearer/index.js:43:26
at Layer.handle [as handle_request] (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/index.js:317:13)
at /Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/index.js:284:7
at Function.process_params (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/index.js:335:12)
at next (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/index.js:275:10)
at expressInit (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/middleware/init.js:40:5)
at Layer.handle [as handle_request] (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/layer.js:95:5)
at trim_prefix (/Users/hisashiyamaguchi/identity-102-exercises/lab-02/begin/api/node_modules/express/lib/router/index.js:317:13)
Part3
Part3ではRefresh Tokenを利用してID Token, Access Tokenをリフレッシュできるようにします。ID TokenやAccess Tokenはネットワークを経由して複数のサービスで使いまわされるため常に漏洩の危険があります。各々に適切な有効期限を設けて、有効期限が切れた場合はRefresh Tokenを認可サーバのToken End Pointに送信し、Tokenを再発行するようにして漏洩を防止します。
Auth0 Dashbord左ペインの"APIs"->"作成したAPI"->"Settings"の"Allow Offline Access"フリップスイッチをオンにして"SAVE"を押します。
ユーザが認証されたタイミングでID Token, Access Tokenと一緒にRefresh Tokenが払い出されます。
webapp/server.jsを修正してExpressミドルウェアに渡すScopeを変更します。以下、修正後のコードです。
require('dotenv').config();constexpress=require('express');consthttp=require('http');constmorgan=require('morgan');constsession=require('cookie-session');constrequest=require('request-promise');const{auth,requiresAuth}=require('express-openid-connect');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.set('view engine','ejs');app.use(morgan('combined'));app.use(session({name:'identity102-lab-02',secret:process.env.COOKIE_SECRET,}));app.use(express.urlencoded({extended:false}));app.use(auth({required:false,auth0Logout:true,authorizationParams:{response_type:'code id_token',audience:process.env.API_AUDIENCE,// 以下1行を修正scope:'openid profile email read:reports offline_access'}}));app.get('/',(req,res)=>{res.render('home',{user:req.openid&&req.openid.user});});app.get('/user',requiresAuth(),(req,res)=>{res.render('user',{user:req.openid&&req.openid.user});});app.get('/expenses',requiresAuth(),async(req,res,next)=>{try{/*
const expenses = await request(process.env.API_URL, {
json: true
});
*/consttokenSet=req.openid.tokens;constexpenses=awaitrequest(process.env.API_URL,{headers:{authorization:"Bearer "+tokenSet.access_token},json:true});res.render('expenses',{user:req.openid&&req.openid.user,expenses,});}catch(err){next(err);}});app.get('/logout',(req,res)=>{req.session=null;res.redirect('/');});app.use((err,req,res,next)=>{console.error(err.stack);res.status(500).send(err);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});webapp/server.jsを修正して、/expenses End PointにTokenの有効期限をチェックするコードを追加します。以下、修正後のコードです。
require('dotenv').config();constexpress=require('express');consthttp=require('http');constmorgan=require('morgan');constsession=require('cookie-session');constrequest=require('request-promise');const{auth,requiresAuth}=require('express-openid-connect');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.set('view engine','ejs');app.use(morgan('combined'));app.use(session({name:'identity102-lab-02',secret:process.env.COOKIE_SECRET,}));app.use(express.urlencoded({extended:false}));app.use(auth({required:false,auth0Logout:true,authorizationParams:{response_type:'code id_token',audience:process.env.API_AUDIENCE,scope:'openid profile email read:reports offline_access'}}));app.get('/',(req,res)=>{res.render('home',{user:req.openid&&req.openid.user});});app.get('/user',requiresAuth(),(req,res)=>{res.render('user',{user:req.openid&&req.openid.user});});app.get('/expenses',requiresAuth(),async(req,res,next)=>{try{/*
const expenses = await request(process.env.API_URL, {
json: true
});
*/// 以下1行をコメントアウト// const tokenSet = req.openid.tokens;// 以下6行を追加lettokenSet=req.openid.tokens;if(tokenSet.expired()){tokenSet=awaitreq.openid.client.refresh(tokenSet);tokenSet.refresh_token=req.openid.tokens.refresh_token;req.openid.tokens=tokenSet;}constexpenses=awaitrequest(process.env.API_URL,{headers:{authorization:"Bearer "+tokenSet.access_token},json:true});res.render('expenses',{user:req.openid&&req.openid.user,expenses,});}catch(err){next(err);}});app.get('/logout',(req,res)=>{req.session=null;res.redirect('/');});app.use((err,req,res,next)=>{console.error(err.stack);res.status(500).send(err);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});Auth0 Dashboardの"APIs"->"作成したAPI"->"Settings"の"Token Expiration (Seconds)", "Token Expiration For Browser Flows (Seconds)"を各々10にして"SAVE"を押します。
この記事ではRefresh Tokenを使ったTokenの再発行を試すため有効期限を極端に短くしています。実際は、サービスの要件に従って適切な有効期限を設定して下さい。
api/api-server.jsを修正してIssu At Time(Tokenが発行された時間)をターミナルに出力します。以下、修正後のコードです。
require('dotenv').config();const{auth,requiredScopes}=require('express-oauth2-bearer');constexpress=require('express');consthttp=require('http');constappUrl=process.env.BASE_URL||`http://localhost:${process.env.PORT}`;constapp=express();app.use(auth());// app.get('/', (req, res) => {app.get('/',requiredScopes('read:reports'),(req,res)=>{// 以下1行を追加console.log(newDate(req.auth.claims.iat*1000));res.send([{date:newDate(),description:'Pizza for a Coding Dojo session.',value:102,},{date:newDate(),description:'Coffee for a Coding Dojo session.',value:42,}]);});http.createServer(app).listen(process.env.PORT,()=>{console.log(`listening on ${appUrl}`);});ターミナルに戻りwebapp, apiを再起動してChromeからhttp://localhost:3000にアクセス、任意のユーザでログイン後、expenses End Pointにアクセスできることを確認します。何度かEnd Pointにアクセスして、ターミナルに出力されるIssue At Timeが異なる=Refresh Tokenを使ってID, Access Tokenが再発行されている, ことが確認できたら成功です。
2019-12-25T05:07:51.000Z
2019-12-25T05:08:11.000Z
2019-12-25T05:08:11.000Z
2019-12-25T05:08:26.000Z
2019-12-25T05:08:26.000Z
おわりに
最後までお付き合い頂きありがとうございます。Micro Service Architecture全盛の昨今、フロントエンドアプリケーションからバックエンドの複数のリソースサーバを呼び出すタイプのサービスアーキテクチャが標準になっており、可搬性・拡張性に優れたTokenベースの認証は不可欠かと思います。Auth0はTokenの有効期限を設定したり、Refresh Tokenを使ってTokenを再発行したりする機能を準備しているので、Application開発者様はTokenの管理を気にするこなく本来の開発作業に集中頂くことができます。