[{"_1":2,"_156":-5,"_157":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/mietzen/blacklistd/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mietzen","reponame","blacklistd","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2021-04-09T11:50:29.862745Z","description","","is_private","last_updated","2021-04-09T12:10:47.357014Z","last_modified","2024-12-26T07:16:46.994962Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",171,"repository_type","star_count",0,"status",6,"status_description","archived","source","collaborator_count","full_description","# blacklistd\n\nThe Blacklist daemon is a blacklist storage for ipv4 and ipv6 addresses. It uses a blacklist provider to populate and update its internal database making sure that ip addresses are not blocked forever. \n\nImplemented providers:\n\n* [abuseipdb](https://abuseipdb.com)\n\nImplemented dababase backends:\n\n* [PostgreSQL](https://www.postgresql.org)\n* [MySQL](https://www.mysql.com)\n* [SQLite](https://www.sqlite.org/)\n\n# Setup\n\n## IP Expiration\n\nProviders like AbuseIPDB limit their blacklist entries to conserve resources. While a list of 10_000 sounds like pretty much, in reality it is pretty limited considering the amount of malicous ips. To further inrease the limit, we use the additional 3_000 free checks using an ip expiration time.\n\nWhen an IP is added or updated, its internal timestamp is updated too. If the timestamp of one ip falls below a certain duration (default is 2 weeks), a manual check validates whether it is still malicous or not. If it is, the timestamp is updated and the ip will remain for 2 more weeks. If it isn't, it is removed immediately. This way, we can increase the limit from 10_000 to up to 10_000 + (2 * 7) * 3_000 (52_000).\n\n|Expiration time|Storage for up to X IPs|\n|---|---|\n|7 days|31_000|\n|14 days|52_000|\n|21 days|73_000|\n|28 days|94_000|\n\nOnce we run into the 3_000 free checks per day limit, we will see ips not getting updated anymore. To make sure that those ips are removed, a stale duration was implemented (default 4 weeks). IPs which weren't updated for the given time are removed without further checking.\n\nYou can configure both durations using the following arguments:\n\n```sh\nblacklistd \\\n --expiration-days 14 \\\n --stale-days 28 \\\n \n```\n\n> Make sure that the stale time is greater then the expiration time. Otherwise ips are removed before being rechecked limiting the storage to the original 10_000\n\n## Provider\n\nAt least one provider is required but multiple are allowed.\n\n### AbuseIPDB\n\nAbuseIPDB requires an APIv2 Key. You can get one on you [account page](https://www.abuseipdb.com/account/api). Afterwards, start the daemon using:\n\n```sh\nblacklistd \\\n --api-abuseipdb \"\" \\\n \n```\n\n## Database\n\nA database backend is required to store ip addresses. You can choose between the following three:\n\n## postgresql\n\nSetup a postgres database with user and password. Afterwards it is necessary to run the following migration (optional with docker). After updating the application, it is necessary to run the migration again:\n\n```sh\ncargo install diesel_cli\n\ndiesel migration run \\\n --migration-dir='./migrations.postgres' \\\n --database-url='postgres://:@:/'\n```\n\nAfterwards you can start the server using:\n\n```sh\nblacklistd \\\n --db-type postgres \\\n --db-host --db-port --db-name \\\n --db-user --db-pass \\\n \n```\n\n## mysql\n\nSetup a mysql database (or similar like mariadb) with user and password. Afterwards it is necessary to run the following migration (optional with docker). After updating the application, it is necessary to run the migration again:\n\n```sh\ncargo install diesel_cli\n\ndiesel migration run \\\n --migration-dir='./migrations.mysql' \\\n --database-url='mysql://:@:/'\n```\n\nAfterwards you can start the server using:\n\n```sh\nblacklistd \\\n --db-type mysql \\\n --db-host --db-port --db-name \\\n --db-user --db-pass \\\n \n```\n\n## sqlite\n\nA dababase file is create when running the following migration. It is, however, also possible to manually create the datbase and to apply the migration afterwards. After updating the application, it is necessary to run the migration again (optional with docker):\n\n```sh\ncargo install diesel_cli\n\ndiesel migration run \\\n --migration-dir='./migrations.sqlite' \\\n --database-url=''\n```\n\nAfterwards you can start the server using:\n\n```sh\nblacklistd \\\n --db-type sqlite \\\n --db-path \"\" \\\n \n```\n\n## Docker\n\nThere is a docker container which automatically migrates a given database. You can set it up using:\n\n```yaml\n bl-pg:\n image: postgres:alpine\n restart: always\n expose:\n - 5432\n environment:\n POSTGRES_DB: blacklistd\n POSTGRES_USER: blacklistd\n POSTGRES_PASSWORD: \n bld-pg:\n image: toendeavour/blacklistd\n restart: always\n expose:\n - 8080\n environment:\n DB_TYPE: postgres\n DB_USER: blacklistd\n DB_PASS: \n DB_HOST: bl-pg\n DB_PORT: 5432\n DB_NAME: blacklistd\n API_ABUSEIPDB: \n\n bl-sql:\n image: mariadb\n restart: always\n expose:\n - 3306\n environment:\n MYSQL_ROOT_PASSWORD: \n MYSQL_DATABASE: blacklistd\n MYSQL_USER: blacklistd\n MYSQL_PASSWORD: \n networks:\n - net\n bld-sql:\n image: toendeavour/blacklistd\n restart: always\n expose:\n - 8080\n environment:\n DB_TYPE: mysql\n DB_USER: blacklistd\n DB_PASS: \n DB_HOST: bl-sql\n DB_PORT: 3306\n DB_NAME: blacklistd\n API_ABUSEIPDB: \n networks:\n - net\n\n bld-sqlite:\n image: toendeavour/blacklistd\n restart: always\n expose:\n - 8080\n environment:\n API_ABUSEIPDB: \n volumes:\n # User must be set to 100:100\n - \"./blacklistd/db.sqlite:/data/db.sqlite\"\n networks:\n - net\n```\n\nOptional Variables:\n\n|Name|Usage|Default|\n|---|---|---|\n|PORT|Set Port for the daemon to listen to|8080|\n|EXPIRATION_TIME|Set ip expiration time|14|\n|STALE_TIME|Set ip stale time|28|\n|LOG_LEVEL|Logging Level; Trace (0), Debug (1), Info (2), Warn (3), Error (4), None (5)|2|\n\n# Usage\n\nThe daemon provides the following API endpoints:\n\n## API / Blacklist\n\nProvides a blacklist containing every ip currently stored in the database\n\n### JSON\n\n|Entpoint|blacklist|\n|---|---|\n|Method|GET|\n|Accept|application/json|\n\n```sh\ncurl http://:/api/blacklist \\\n -H \"Accept: application/json\"\n\n# Response:\n# [\"10.0.0.1\", \"10.0.0.2\", ...]\n```\n\n### Plain\n\n|Entpoint|blacklist|\n|---|---|\n|Url|api/blacklist|\n|Method|GET|\n|Accept|text/plain|\n\n```sh\ncurl http://:/api/blacklist \\\n -H \"Accept: text/plain\"\n\n# Response:\n# 10.0.0.1\n# 10.0.0.2\n# ...\n```\n\n## API / Health\n\nQuick health check. Does not check database health.\n\n|Entpoint|health|\n|---|---|\n|Url|api/health|\n|Method|GET|\n\n```sh\ncurl http://:/api/health\n\n# Response:\n# True\n```\n\n## API / System Health\n\nFull health check.\n\n|Entpoint|system_health|\n|---|---|\n|Url|api/system_health|\n|Method|GET|\n\n```sh\ncurl http://:/api/system_health\n\n# Response:\n# True\n```\n\n## Stats / Count\n\nNumber of IPs in the database\n\n### JSON\n\n|Entpoint|count|\n|---|---|\n|Url|stats/count|\n|Method|GET|\n|Accept|application/json|\n\n```sh\ncurl http://:/stats/count \\\n -H \"Accept: application/json\"\n\n# Response:\n# {\"count\":10486}\n```\n\n### Plain\n\n|Entpoint|count|\n|---|---|\n|Url|stats/count|\n|Method|GET|\n|Accept|text/plain|\n\n```sh\ncurl http://:/stats/count \\\n -H \"Accept: text/plain\"\n\n# Response:\n# 10486\n```\n\n## Stats / Count per day\n\nNumber of IPs in the database grouped by the day of its last check\n\n### JSON\n\n|Entpoint|countPerDay|\n|---|---|\n|Url|stats/countPerDay|\n|Method|GET|\n|Accept|application/json|\n\n```sh\ncurl http://:/stats/countPerDay \\\n -H \"Accept: application/json\"\n\n# Response:\n# [{\n# \"count\":10000,\n# \"last_update_start\":\"2019-09-30T00:00:16.326944\",\n# \"last_update_end\":\"2019-09-30T00:01:21.966092\"\n# },{\n# \"count\":486,\n# \"last_update_start\":\"2019-09-28T10:44:15.972453\",\n# \"last_update_end\":\"2019-09-28T10:44:40.463461\"\n# }]\n```\n\n### Plain\n\n|Entpoint|countPerDay|\n|---|---|\n|Url|stats/countPerDay|\n|Method|GET|\n|Accept|text/plain|\n\n```sh\ncurl http://:/stats/countPerDay \\\n -H \"Accept: text/plain\"\n\n# Response:\n# 10000 2019-09-30 00:00:16.326944 2019-09-30 00:01:21.966092\n# 486 2019-09-28 10:44:15.972453 2019-09-28 10:44:40.463461\n```\n\n# Build / Install\n\nYou can either checkout the repository and build it using:\n\n```sh\ncargo build [--release]\n```\n\nor you can install it using:\n\n```sh\ncargo install --git https://github.com/mettke/blacklistd.git\n```\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",9545539,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":104,"_122":114,"_123":112,"_124":17},"content_type","creator",3437908,"full_size",9538184,"id",144944571,"images",[97],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":112,"_113":-5},"architecture","amd64","digest","sha256:ec08327f4d2a2f24e8eae734e7f51000886661567a7b23d6018c1642819db088","features","last_pulled","2026-09-24T00:38:31.391475083Z","last_pushed","2021-04-09T12:10:47Z","os","linux","os_features","os_version","size","active","variant","2021-04-09T12:10:47.001526Z","last_updater","last_updater_username","media_type","latest","repository",12236466,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":154,"_155":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":146,"_147":-5,"_148":-5,"_149":150},"count",1,"next","previous","results",[151],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":152,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":104,"_122":114,"_123":112,"_124":17},[153],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":112,"_113":-5},[],"canDeleteTags","actionData","errors"]

mietzen/blacklistd

Tags for mietzen/blacklistd