{"id":28571785,"url":"https://github.com/romanow/log4j2-masking-lib","last_synced_at":"2025-06-29T22:34:59.698Z","repository":{"id":239827840,"uuid":"800523916","full_name":"Romanow/log4j2-masking-lib","owner":"Romanow","description":"Masking library for Log4j2","archived":false,"fork":false,"pushed_at":"2025-06-10T11:45:27.000Z","size":100,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-10T12:19:14.693Z","etag":null,"topics":["log4j2","masking"],"latest_commit_sha":null,"homepage":"https://romanow.github.io/log4j2-masking/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Romanow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-05-14T13:52:19.000Z","updated_at":"2025-06-10T11:45:31.000Z","dependencies_parsed_at":"2024-05-22T16:29:03.775Z","dependency_job_id":"91d226f6-81b3-4fef-b99e-06bc6378f4e9","html_url":"https://github.com/Romanow/log4j2-masking-lib","commit_stats":null,"previous_names":["romanow/logs-masking-example","romanow/log4j2-masking","romanow/log4j2-masking-lib"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking-lib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking-lib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking-lib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking-lib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Romanow","download_url":"https://codeload.github.com/Romanow/log4j2-masking-lib/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking-lib/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259137296,"owners_count":22810663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["log4j2","masking"],"created_at":"2025-06-10T19:37:53.267Z","updated_at":"2025-06-10T19:37:55.053Z","avatar_url":"https://github.com/Romanow.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CI](https://github.com/Romanow/log4j2-masking-lib/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/Romanow/log4j2-masking-lib/actions/workflows/build.yml)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n[![Release](https://img.shields.io/github/v/release/Romanow/log4j2-masking-lib?logo=github\u0026sort=semver)](https://github.com/Romanow/log4j2-masking-lib/releases/latest)\n[![Codecov](https://codecov.io/gh/Romanow/log4j2-masking-lib/branch/master/graph/badge.svg?token=Cckw6pHLh7)](https://codecov.io/gh/Romanow/log4j2-masking-lib)\n[![License](https://img.shields.io/github/license/Romanow/log4j2-masking-lib)](https://github.com/Romanow/log4j2-masking-lib/blob/master/LICENSE)\n\n# Masking library for Log4j2\n\n## Подключение\n\n### Maven\n\n```xml\n\n\u003cdependency\u003e\n    \u003cgroupId\u003eru.romanow.logging\u003c/groupId\u003e\n    \u003cartifactId\u003elog4j2-masking-lib\u003c/artifactId\u003e\n    \u003cversion\u003e${log-masking-lib.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle\n\n```groovy\ntestImplementation \"ru.romanow.logging:log4j2-masking-lib:$logMaskingVersion\"\n```\n\n## Реализация\n\nДля маскирования логов используется\nплагин [`MaskingConverter`](src/main/kotlin/ru/romanow/logging/filter/MaskingConverter.kt).\n\nДля его подключения используется annotation processor `org.apache.logging.log4j:log4j-core`, который собирает плагины\nв [`$buildDir/tmp/kapt3/classes/main/META-INF/org/apache/logging/log4j/core/config/plugins/Log4j2Plugins.dat`](build/tmp/kapt3/classes/main/META-INF/org/apache/logging/log4j/core/config/plugins/Log4j2Plugins.dat).\n\nВ шаблоне этот конвертер вызывается как `%mask{ %msg }`:\n\n```xml\n\n\u003cPatternLayout pattern=\"%d{yyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %mask{ %msg }%n\"/\u003e\n```\n\n## Правила маскирования\n\nТип поля:\n\n* `email` –\u003e `romanowalex@mail.ru` -\u003e `r**********@mail.ru`.\n* `firstName` –\u003e не маскируется.\n* `lastName`, `middleName` –\u003e if (name.length \u003e 7) `Ab*****c` else `A*****`.\n* `text` –\u003e в зависимости от длины:\n    * 1 -\u003e `*`;\n    * 1..4 -\u003e `1234` -\u003e `1***`;\n    * 5..9 -\u003e `123456789` -\u003e `1******89` (length * 60%);\n    * 10..15 -\u003e `12345678901` -\u003e `12*******01` (length * 60%);\n    * 16 + -\u003e `12345678901234567` -\u003e `123***********567` (length * 60%);\n\nПравила описаны в [`resources/logging/rules.yml`](src/main/resources/logging/rules.yml). Если требуется добавить новые\nправила, то нужно в `resources/logging` создать файл `additional-rules.yml`.\n\n```yaml\nmasking:\n  - field: 'fullName'\n    type: FULL_NAME\n  - field: 'lastName'\n    type: NAME\n  - field: 'email'\n    type: EMAIL\n  - field: 'JWT'\n    type: TEXT\n  - regex: '(?:JWT|Authorization)\\s*(?::|=)\\s*(.+)'\n    type: TEXT\n ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Flog4j2-masking-lib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromanow%2Flog4j2-masking-lib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Flog4j2-masking-lib/lists"}