Hapi-Auth-Bearer-Token 使用手册

Hapi-Auth-Bearer-Token 使用手册

hapi-auth-bearer-tokenSimple Bearer authentication scheme plugin for hapi, accepts token by Header, Cookie or Query parameter.项目地址:https://gitcode.com/gh_mirrors/ha/hapi-auth-bearer-token

本手册旨在指导您如何理解和使用 hapi-auth-bearer-token 这一Hapi插件。该插件提供了一种方式来验证使用Bearer令牌的HTTP请求，这是访问受保护资源的常用手段。

1. 目录结构及介绍

假设您已经克隆了https://github.com/johnbrett/hapi-auth-bearer-token.git，以下是基本的目录结构说明：

• lib: 包含核心逻辑的JavaScript文件，这里是实现Bearer令牌验证的关键代码。
• test: 测试用例的存放地，对插件的功能进行单元测试以确保其稳定性。
• package.json: 描述项目依赖和元数据的重要文件，包括脚本命令、版本信息等。
• README.md: 提供快速入门指南和基本的使用说明。

2. 项目的启动文件介绍

虽然直接的启动文件不在这个库中（因为它本身是用来被集成到你的Hapi服务器应用中的），但通常在使用此插件的应用项目中，启动文件（比如server.js或app.js）应包含以下步骤来初始化并运行服务：

1. 引入Hapi框架:

   const Hapi = require('@hapi/hapi');
   

2. 引入hapi-auth-bearer-token插件:

   const AuthBearer = require('hapi-auth-bearer-token');
   

3. 配置和注册插件:

   await server.register(AuthBearer);
   

4. 定义认证策略: 设置策略允许从查询字符串或头部获取Bearer令牌，并指定自定义验证函数。

   server.auth.strategy('simple', 'bearer-access-token', {
       allowQueryToken: true, // 可选，默认为false
       validate: async (request, token, h) => {
           // 验证token的有效性，示例中简单比较。
           const isValid = token === '预期的令牌值';
           if (isValid) {
               return {
                   isValid: true,
                   credentials: { token },
                   artifacts: { /* 可选附加信息 */ }
               };
           }
           return { isValid: false };
       }
   });
   

5. 设置默认认证策略并在路由上应用:

   server.auth.default('simple');
   server.route({ 
       method: 'GET', 
       path: '/', 
       options: { auth: 'simple' }, 
       handler: async (request, h) => { ... } 
   });
   

6. 启动服务器:

   await server.start();
   console.log(`Server running at: ${server.info.uri}`);
   

3. 项目的配置文件介绍

对于hapi-auth-bearer-token插件自身并没有特定的配置文件，所有的配置都是通过在Hapi服务器上定义认证策略完成的。上述的validate函数就是核心配置的一部分，它定义了如何处理和验证接收到的Bearer令牌。此外，可通过Hapi的常规方法来配置服务器端口、模式等参数，这些通常是在您的应用程序主文件（如server.js）中进行。

请注意，尽管没有特定的“配置文件”，Hapi框架支持环境变量或.env文件来管理外部配置，这可以间接地为插件的特定配置需求提供灵活性。确保理解并适当利用Hapi的配置机制来适应不同的部署环境。

hapi-auth-bearer-tokenSimple Bearer authentication scheme plugin for hapi, accepts token by Header, Cookie or Query parameter.项目地址:https://gitcode.com/gh_mirrors/ha/hapi-auth-bearer-token