{"id":24313968,"url":"https://github.com/romanow/log4j2-masking","last_synced_at":"2025-03-09T15:54:31.747Z","repository":{"id":239827840,"uuid":"800523916","full_name":"Romanow/log4j2-masking","owner":"Romanow","description":"Mask log output to fluent-bit and console","archived":false,"fork":false,"pushed_at":"2024-12-02T21:31:49.000Z","size":117,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-17T09:31:09.228Z","etag":null,"topics":["elk-stack","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}},"created_at":"2024-05-14T13:52:19.000Z","updated_at":"2024-12-15T15:38:48.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","commit_stats":null,"previous_names":["romanow/logs-masking-example","romanow/log4j2-masking"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Romanow%2Flog4j2-masking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Romanow","download_url":"https://codeload.github.com/Romanow/log4j2-masking/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242714054,"owners_count":20173581,"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":["elk-stack","log4j2","masking"],"created_at":"2025-01-17T09:24:14.701Z","updated_at":"2025-03-09T15:54:31.739Z","avatar_url":"https://github.com/Romanow.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build project](https://github.com/Romanow/logs-masking-example/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/Romanow/logs-masking-example/actions/workflows/build.yml)\n[![codecov](https://codecov.io/gh/Romanow/logs-masking-example/branch/master/graph/badge.svg?token=Cckw6pHLh7)](https://codecov.io/gh/Romanow/logs-masking-example)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)\n\n# Masking logs\n\n## Подключение\n\n### Maven\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eru.romanow.logging\u003c/groupId\u003e\n  \u003cartifactId\u003elog-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:log-masking-lib:$logMaskingVersion\"\n```\n\n## Реализация\n\nДля маскирования логов используется\nплагин [`MaskingConverter`](log-masking-lib/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Отправка в ELK выполняется в формате JSON через fluent-bit (по адресу localhost:5170), для сборки сообщения\nиспользуется `JsonTemplateLayout` (шаблон [layout.json](log-masking-lib/src/main/resources/logging/layout.json), для маскирования\nиспользуется pattern resolver как `%mask{ %msg }`.\n\n\n## Тестирование\n\n```shell\n$ docker compose up -d\n\n$ ./gradlew bootRun --args='--spring.profiles.active=docker'\n\n$ curl http://localhost:8080/api/v1/send \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"lastName\": \"Alex\"}'\n\n$ docker compose logs -f fluent-bit\n\n```\n\nВывод fluent-bit:\n\n```\nfluent-bit  | {\"localTime\"=\u003e\"2024-05-14T20:47:40.589Z\", \"level\"=\u003e\"INFO\", \"text\"=\u003e\"Initializing Servlet 'dispatcherServlet'\", \"levelInt\"=\u003e6, \"loggerName\"=\u003e\"org.springframework.web.servlet.DispatcherServlet\", \"threadName\"=\u003e\"http-nio-8080-exec-1\", \"appName\"=\u003e\"log-masking\", \"appType\"=\u003e\"JAVA\"}]\nfluent-bit  | {\"localTime\"=\u003e\"2024-05-14T20:47:40.590Z\", \"level\"=\u003e\"INFO\", \"text\"=\u003e\"Completed initialization in 1 ms\", \"levelInt\"=\u003e6, \"loggerName\"=\u003e\"org.springframework.web.servlet.DispatcherServlet\", \"threadName\"=\u003e\"http-nio-8080-exec-1\", \"appName\"=\u003e\"log-masking\", \"appType\"=\u003e\"JAVA\"}]\nfluent-bit  | {\"localTime\"=\u003e\"2024-05-14T20:47:40.620Z\", \"level\"=\u003e\"INFO\", \"text\"=\u003e\"{\"lastName\":\"\u003cmasked\u003e\"}\", \"levelInt\"=\u003e6, \"loggerName\"=\u003e\"ru.romanow.logging.web.LogSender\", \"threadName\"=\u003e\"http-nio-8080-exec-1\", \"appName\"=\u003e\"log-masking\", \"appType\"=\u003e\"JAVA\"}]\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Конфигурация:\n\n```yaml\napplication:\n    masking:\n        -   field: fullName\n            type: FULL_NAME\n        -   field: lastName\n            type: LAST_NAME\n        -   field: email\n            type: EMAIL\n        -   field: JWT\n            type: TEXT\n        -   regex: Authorization\\s*:\\s*(\\S+)\n            type: TEXT\n ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Flog4j2-masking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromanow%2Flog4j2-masking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanow%2Flog4j2-masking/lists"}