{"id":13588629,"url":"https://github.com/nwtgck/http-knocking","last_synced_at":"2025-09-14T18:59:35.903Z","repository":{"id":48273597,"uuid":"144938302","full_name":"nwtgck/http-knocking","owner":"nwtgck","description":"🚪HTTP-Knocking hides a Web server and open it by knocking sequence: Hide Web server until your knocks","archived":false,"fork":false,"pushed_at":"2021-08-03T19:07:47.000Z","size":4873,"stargazers_count":31,"open_issues_count":30,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-08-18T18:52:29.668Z","etag":null,"topics":["docker","http","npm","port-knocking","proxy-server","reverse-proxy","security"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/nwtgck.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}},"created_at":"2018-08-16T04:54:32.000Z","updated_at":"2025-05-30T20:23:33.000Z","dependencies_parsed_at":"2022-09-03T15:13:16.046Z","dependency_job_id":null,"html_url":"https://github.com/nwtgck/http-knocking","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/nwtgck/http-knocking","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Fhttp-knocking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Fhttp-knocking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Fhttp-knocking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Fhttp-knocking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nwtgck","download_url":"https://codeload.github.com/nwtgck/http-knocking/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwtgck%2Fhttp-knocking/sbom","scorecard":{"id":699551,"data":{"date":"2025-08-11","repo":{"name":"github.com/nwtgck/http-knocking","commit":"b88552f6202c783a902535b99951b16f94246034"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/4 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'develop'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:10.16-alpine to node:10.16-alpine@sha256:77c898d0da5e7bfb6e05c9a64de136ba4e03889a72f3c298e95df822a38f450d","Warn: npmCommand not pinned by hash: Dockerfile:12-14","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"57 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc","Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w","Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf","Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T04:52:08.860Z","repository_id":48273597,"created_at":"2025-08-22T04:52:08.860Z","updated_at":"2025-08-22T04:52:08.860Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275152613,"owners_count":25414450,"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","status":"online","status_checked_at":"2025-09-14T02:00:10.474Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker","http","npm","port-knocking","proxy-server","reverse-proxy","security"],"created_at":"2024-08-01T15:06:49.866Z","updated_at":"2025-09-14T18:59:35.880Z","avatar_url":"https://github.com/nwtgck.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# http-knocking\n\n[![NpmVersion](https://img.shields.io/npm/v/http-knocking.svg)](https://www.npmjs.com/package/http-knocking) [![CircleCI](https://circleci.com/gh/nwtgck/http-knocking.svg?style=shield)](https://circleci.com/gh/nwtgck/http-knocking) [![Docker Automated build](https://img.shields.io/docker/automated/nwtgck/http-knocking.svg)](https://hub.docker.com/r/nwtgck/http-knocking/) [![](https://images.microbadger.com/badges/image/nwtgck/http-knocking.svg)](https://microbadger.com/images/nwtgck/http-knocking \"Get your own image badge on microbadger.com\")\n\nHTTP knocking is like port knocking. It hides your server, and allows you to open/close the server by certain knocking.   \nIn HTTPS communication, knocking is hidden because of encryption unlike port knocking.\n\n![demo1](demo_images/demo1.gif)\n\n## Run with npm\n\nSuppose http://localhost:8181/ is running. The following command runs a http-knocking server on port 8282.\n\n```bash\nnpm install -g http-knocking\nhttp-knocking --port=8282 --target-host=localhost --target-port=8181 --open-knocking=\"/alpha,/foxtrot,/lima\"\n```\n\nIn the case of `--open-knocking=\"/alpha,/foxtrot,/lima\"`, you can **open the server** by accessing to\n\n1. \u003chttp://localhost:8282/alpha\u003e\n1. \u003chttp://localhost:8282/foxtrot\u003e\n1. \u003chttp://localhost:8282/lima\u003e  \n\nClose procedure is the reverse order of open if `--close-knocking` is not specfied.  \nTechnically, `localhost:8282` is a reverse proxy server to `localhost:8181`.\n\n\n## Run with Docker Compose\n\nHere is a `docker-compose.yml` to run [Ghost](https://ghost.org/) on http-knocking.\n\n```yaml\nversion: '3.1'\nservices:\n  http-knocking:\n    image: nwtgck/http-knocking:v0.3.1\n    ports:\n      - '8282:8282'\n    depends_on:\n      - ghost\n    restart: always\n    command: --port=8282 --target-host=ghost --target-port=2368 --open-knocking=\"/alpha,/foxtrot,/lima\"\n  ghost:\n    image: ghost\n    restart: always\n    expose:\n      - \"2368\"\n```\n\n## Options\n\nHere is available options.\n\n```\nOptions:\n  --help                               Show help                       [boolean]\n  --version                            Show version number             [boolean]\n  --port                               Port of knocking server\n                                                             [number] [required]\n  --target-host                        Target host to hide   [string] [required]\n  --target-port                        Target port to hide[number] [default: 80]\n  --open-knocking                      Open-knocking sequence (e.g.\n                                       \"/alpha,/foxtrot,/lima\")         [string]\n  --close-knocking                     Close-knocking sequence (e.g.\n                                       \"/victor,/kilo\")                 [string]\n  --enable-websocket                   Enable WebSocket proxy   [default: false]\n  --auto-close-millis                  Time millis to close automatically\n                                                                        [number]\n  --open-knocking-max-interval-millis  Time millis to reset open procedure\n                                                                        [number]\n  --http-request-limit                 Limit of HTTP request            [number]\n  --on-upgrade-limit                   Limit of on-upgrade (WebSocket)  [number]\n  --enable-fake-nginx                  Enable fake Nginx Internal Server Error\n                                       response                 [default: false]\n  --fake-nginx-version                 Nginx version in fake Nginx Internal\n                                       Server Error response [default: \"1.15.2\"]\n  --enable-empty-response              Enable empty response (NOTE: Not empty\n                                       HTTP body)               [default: false]\n  --enable-knocking-update             Enable auto knocking-update\n                                                                [default: false]\n  --knocking-update-interval-sec       Interval millis of auto knocking-update\n                                                                 [default: 1800]\n  --min-knocking-length                Min knocking length used in auto\n                                       knocking-update              [default: 6]\n  --max-knocking-length                Max knocking length used in auto\n                                       knocking-update              [default: 8]\n  --n-knockings                        The number of knocking sequence used in\n                                       auto knocking-update         [default: 3]\n  --webhook-url                        Webhook URL used in auto knocking-update\n                                                                        [string]\n  --webhook-template-path              Webhook template file path used in auto\n                                       knocking-update                  [string]\n```\n\n `--auto-close-millis` option makes your server more secure because it closes automatically by time.  \n `--open-knocking-max-interval-millis` option also makes your server more secure because it resets open procedure by time.  \n `--http-request-limit` restricts the number of HTTP requests after knocking server opening.  \n `--on-upgrade-limit` restricts the number of on-upgrade (WebSocket) after knocking server opening.  \n `--enable-fake-nginx` option fakes server response like \"Nginx Internal Server Error\" when the knocking server is closed.    \n `--fake-nginx-version` option specifies Nginx version used in fake \"Internal Server Error\" response.      \n `--enable-empty-response` option changes a knocking server response to be empty when the knocking server is closed\n\n ## Auto Knocking-Update\n\n To get more secure, `--enable-knocking-update` option updates knocking-sequences regularly and notifies new sequences via Webhook. You can use **any Webhook-supported services**.\n\nHere is a demo to notify to [Slack](https://slack.com).\n\n ![Auto Knocking-Update to Slack](demo_images/auto-knocking-update-slack.gif)\n\nHere is a demo to notify to [Discord](https://discordapp.com).\n\n ![Auto Knocking-Update to Discord](demo_images/auto-knocking-update-discord.gif)\n \nTemplates of JSON notified to the services are located at  \n- [webhook-templates/slack_template.json](webhook-templates/slack_template.json)\n- [webhook-templates/discord_template.json](webhook-templates/discord_template.json)\n\nThe following options are required to enable auto knocking-update.\n* `--enable-knocking-update`\n* `--webhook-url=https://...`\n* `--webhook-template-path=./path/to/webhook/template`\n\n### Fake English words\n\nFake English words used in auto knocking-update are generated by [fakelish](https://github.com/nwtgck/fakelish-npm).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwtgck%2Fhttp-knocking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnwtgck%2Fhttp-knocking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwtgck%2Fhttp-knocking/lists"}