# token-template

**Repository Path**: yycloudopen/token-template

## Basic Information

- **Project Name**: token-template
- **Description**: 自定义安全认证插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-19
- **Last Updated**: 2022-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 如何自定义安全认证插件

##自定义安全认证插件步骤


1. 下载token-template源码到本地
2. 在CustomTokenPlugin的doAuth方法处填写自定义插件的业务逻辑，同时把自己的插件加入到CustomTokenMoudle中
3. 修改resource/ucg-config.json文件
4. 使用maven打包

##ucg-config.json说明
ucg-config.json是整个插件的配置，系统会读取resource/ucg-config.json，并根据其中的内容来加载插件  

* packageName  当前插件包的名称
* moduleClass  module的全路径名
* config  可以设置键值对，在插件中进行读取
* plugin插件包中的插件信息，一个插件包中可以有多个插件。每个插件的信息如下：
    * pluginType  插件类型(6表示安全认证插件)
    * classPath  插件实现类的全路径名
    * name  插件名称
    * description  插件描述


##注意事项
1. 一个插件包中包含多个插件时，请保持每个 classPath 唯一
2. config中键值对的信息可以通过plugin类中的config来进行读取
3. 安全认证插件中如果需要执行一些耗时的操作，建议使用io.vertx.core.Vertx.executeBlocking(io.vertx.core.Handler<io.vertx.core.Promise<T>>, boolean, io.vertx.core.Handler<io.vertx.core.AsyncResult<T>>)

##插件部署

1. 联系网关管理员分配插件管理权限

2. 新增插件信息，根据自己的插件填写相关信息，可以配置参数在插件中读取

   ![image-20210121111204581](src/picture/image-20210121111204581.png)

   ![image-20210121111226199](src/picture/image-20210121111226199.png)

3. 进入操作中的版本管理，新增版本，上传插件包，填写发版说明

   ![image-20210121111434048](src/picture/image-20210121111434048.png)

   ![image-20210121111456543](src/picture/image-20210121111456543.png)

4. 点击申请部署，联系网关管理员审批，审批完成即可在API注册时选择并使用插件

   ![image-20210121111630430](src/picture/image-20210121111630430.png)

5. 插件可以授权给其他人使用

   ![image-20210121111746356](src/picture/image-20210121111746356.png)