Secure-ext-spring-boot-starter

1. Введение

Специализируется на области безопасности, реализует скрытие данных, ожидается достижение гибкой конфигурации, гибкого включения и желательно встроенных богатых плагинов. Поддерживает различные типы данных: мобильный телефон, адрес электронной почты, номер удостоверения личности, адрес, стационарный телефон, номер банковской карты, а также пользовательские данные.

Так появился этот компонент: secure-ext-spring-boot-starter.

2. Преимущества

• Простота интеграции: достаточно включить starter пакет, нет необходимости в какой-либо начальной настройке;

• Гибкость: вплоть до уровня метода;

• Встроенные богатые возможности: встроенные разнообразные типы по умолчанию, а также возможность поддержки пользовательских правил скрытия данных в соответствии с индивидуальными потребностями;

• Автоматизация: поддерживает глубокое скрытие данных и автоматическое обнаружение вложенных объектов, содержащих свойства, требующие скрытия, в возвращаемых значениях.

3. Последняя версия

4. Использование

4.1 Включение зависимости

<dependency>
  <groupId>io.gitee.chemors</groupId>
  <artifactId>secure-ext-spring-boot-starter</artifactId>
  <version>Последняя версия</version>
</dependency>

4.2 Включение скрытия данных

sensitive:
  enable: true # значение по умолчанию — true
  depth: false # значение по умолчанию — false
  packages: # путь сканирования пакетов, значение по умолчанию — пустое

4.3 Добавление аннотаций

Примечание:

• аннотации методов указывают на необходимость скрытия возвращаемого значения метода;
• аннотации свойств определяют конкретные правила скрытия.

4.3.1 Добавление аннотации метода

@Desensitization
public Obj test(){
    // бизнес-логика, построение возвращаемого объекта Obj
    return Obj;
}

4.3.2 Добавление аннотации свойства

 @DesensitizationProp(SensitiveTypeEnum.MOBILE_PHONE)
 private String mobile;

5. Типы по умолчанию

• CHINESE_NAME // китайское имя
• ID_CARD // номер удостоверения личности
• FIXED_PHONE // стационарный телефон
• MOBILE_PHONE // мобильный телефон
• ADDRESS // адрес
• EMAIL // адрес электронной почты
• BANK_CARD // номер банковской карты
• PASSWORD // пароль
• CUSTOM // пользовательский (совместно с DesensitizationProp для определения длины префикса и суффикса)

6. Демо

• secure-ext-demo

7. Пример

7.1 Данные бэкенда

       @Desensitization
        public SensitiveEntity simpleData() {
            SensitiveEntity sensitiveEntity = new SensitiveEntity();
            sensitiveEntity.setId("1");
            sensitiveEntity.setName("樱木花道");
            sensitiveEntity.setMobile("15699996666");
            sensitiveEntity.setIdCard("101010200001010001");
            return sensitiveEntity;
        }

7.2 Результат возврата

{
  "id": "1",
  "name": "樱***",
  "mobile": "156****6666",
  "idCard": "101010********0001"
}

8. Другие открытые проекты

• Спрингбут-основанный проект для быстрой разработки платформы — eboot

9. Лицензия

Apache License 2.0

10. Пожертвования

11. Следите за мной

12. Журнал обновлений

• V1.0.0

Базовая версия

• V1.0.1

Поддержка сложных объектов, многоуровневое вложение атрибутов с автоматическим скрытием

• V1.0.2

Оптимизация ссылок на пакеты

• V1.0.3

Поддержка глубокого скрытия

• V1.0.4

Добавлена поддержка типа Map, при возврате значения типа Map автоматически выполняется обход его значений для обработки скрытия

• V2.0.0

Добавлено скрытие на основе logback, поддерживается формат строк, json и простых сущностей