{"id":20489429,"url":"https://github.com/telus/keymaster-client","last_synced_at":"2025-09-25T05:30:22.674Z","repository":{"id":40407458,"uuid":"270818773","full_name":"telus/keymaster-client","owner":"telus","description":"Configures wireguard using information from keymaster-server","archived":true,"fork":false,"pushed_at":"2025-01-23T23:24:12.000Z","size":77,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-31T14:55:27.460Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/telus.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":"2020-06-08T20:33:01.000Z","updated_at":"2025-01-23T23:24:33.000Z","dependencies_parsed_at":"2022-09-15T10:21:41.234Z","dependency_job_id":null,"html_url":"https://github.com/telus/keymaster-client","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/telus/keymaster-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkeymaster-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkeymaster-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkeymaster-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkeymaster-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/telus","download_url":"https://codeload.github.com/telus/keymaster-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/telus%2Fkeymaster-client/sbom","scorecard":{"id":873415,"data":{"date":"2025-08-11","repo":{"name":"github.com/telus/keymaster-client","commit":"64c6a3b4aff5c00df2ddfee4a0fdb6e25cd93569"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Code-Review","score":1,"reason":"Found 1/7 approved changesets -- score normalized to 1","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":"project is archived","details":["Warn: Repository is archived."],"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/package.yml:1","Warn: no topLevel permission defined: .github/workflows/shipit.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Info: no jobLevel write permissions found"],"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/package.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/shipit.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/shipit.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/shipit.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/shipit.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/telus/keymaster-client/test.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/lint.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/lint.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/package.yml:21","Warn: pipCommand not pinned by hash: .github/workflows/package.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/package.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/shipit.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/shipit.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/shipit.yml:33","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/test.yml:32","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  10 pipCommand 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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" 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 'master'"],"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":"Vulnerabilities","score":0,"reason":"14 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: PYSEC-2018-49 / GHSA-rprw-h62v-c2w7","Warn: Project is vulnerable to: PYSEC-2014-14 / GHSA-652x-xj99-gmcc","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2014-13 / GHSA-cfj3-7x9c-4p3h","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg","Warn: Project is vulnerable to: PYSEC-2013-9 / GHSA-4gv5-qhvr-36vv","Warn: Project is vulnerable to: PYSEC-2021-437 / GHSA-5xp3-jfq3-5q8x","Warn: Project is vulnerable to: PYSEC-2019-160 / GHSA-c5h8-cq4v-cvfm","Warn: Project is vulnerable to: PYSEC-2013-8 / GHSA-g3p5-fjj9-h8gj","Warn: Project is vulnerable to: PYSEC-2020-173 / GHSA-gpvv-69j7-gwj8","Warn: Project is vulnerable to: PYSEC-2023-228 / GHSA-mq26-g339-26xf","Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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"}}]},"last_synced_at":"2025-08-24T05:00:41.589Z","repository_id":40407458,"created_at":"2025-08-24T05:00:41.589Z","updated_at":"2025-08-24T05:00:41.589Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276864674,"owners_count":25718307,"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-25T02:00:09.612Z","response_time":80,"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":[],"created_at":"2024-11-15T17:12:53.315Z","updated_at":"2025-09-25T05:30:22.669Z","avatar_url":"https://github.com/telus.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Archived 2025-01-23\nNo longer supported\n\n# keymaster-client\n\nkeymaster-client is the client portion of the keymaster wireguard\nkey distribution solution. This readme is limited to configuration of\nthe keymaster-client daemon; for an overview and general information\nplease see [the keymaster-server repo](https://github.com/telus/keymaster-server).\n\n\n## Installation \u0026 Usage\n\nTo install keymaster-client:\n\n```\npip install keymaster-client\n```\n\nTo run keymaster-client, first create a configuration (see below) and then run:\n\n```\nkeymaster_client\n```\n\n\n## Configuration\n\nBy default, keymaster-client looks for configuration at the path\n/etc/keymaster_client.yaml. You can change this by passing the desired\npath in the `-f` or `--path-to-config` flags.\n\n### Example Configuration\n\n```\n---\nkeymasterServer:\n  url: https://example.com:5300\n  token: a-fake-token\nwg:\n  configDir: /var/different/directory/\nsyncPeriod: 30\n```\n\n### Configuration Reference\n\n**`keymasterServer`**\n\nIf present, indicates that the `keymasterServer` ConfigSource is to be used.\nCannot be used at the same time as the uDPUAPI ConfigSource.\n\n--------------------------------------------------------------------------------\n\n**`keymasterServer.url`**\n\nRequired if `keymasterServer` is specified. The complete URL of the\nkeymaster-server deployment.\n\n--------------------------------------------------------------------------------\n\n**`keymasterServer.token`**\n\nRequired if `keymasterServer` is specified. The token to use in requests to\nthe keymaster-server deployment. This token can be obtained from the\nkeymaster-server web UI.\n\n--------------------------------------------------------------------------------\n\n**`uDPUAPI`**\n\nA ConfigSource for a proprietary system. Cannot be used at the same time as\nthe keymasterServer ConfigSource.\n\n--------------------------------------------------------------------------------\n\n**`uDPUAPI.url`**\n\nRequired if `uDPUAPI` is specified. The complete URL of the uDPU API deployment.\n\n--------------------------------------------------------------------------------\n\n**`uDPUAPI.networkName`**\n\nRequired if `uDPUAPI` is specified. The network name to request config for on the\nuDPU API.\n\n--------------------------------------------------------------------------------\n\n**`uci`**\n\nA ConfigScheme that uses OpenWrt's UCI (Universal Configuration Interface) to\nconfigure wireguard interfaces. Has no options. Cannot be used at the same time\nas the `wg` ConfigScheme. For more information on UCI please see\n[the OpenWrt wiki](https://openwrt.org/docs/guide-user/base-system/uci).\n\n--------------------------------------------------------------------------------\n\n**`wg`**\n\nA ConfigScheme that uses the `ip` and `wg` commands to configure wireguard\ninterfaces on the host running keymaster-client. Cannot be used at the same\ntime as the `wg` ConfigScheme.\n\n--------------------------------------------------------------------------------\n\n**`wg.configDir`**\n\nOptional. Default: /var/lib/keymaster_client/\n\nThe directory in which configuration is stored after syncing with the\nConfigSource.\n\n--------------------------------------------------------------------------------\n\n**`privateKey`**\n\nOptional.\n\nAllows you to specify the private key that this deployment of keymaster-client\nwill configure **all** interfaces with. This value takes precedence over any\nvalues that otherwise would be generated by keymaster-client. This setting\nis useful if you have multiple non-endpoint interfaces behind a load balancer that\nyou want to appear as a single highly-available interface to any endpoint\ninterfaces connecting to them. \n\n--------------------------------------------------------------------------------\n\n**`syncPeriod`**\n\nOptional. Default: 60\n\nLets you specify the interval, in seconds, at which keymaster-client requests\nconfiguration from the ConfigSource.\n\n\n## Extending\n\nkeymaster-client provides two interfaces that make it easy to modify:\n\nA **`ConfigScheme`** specifies how wireguard configurations are written to,\nand read from, the Node.\n\nA **`ConfigSource`** tells keymaster-client how to get configuration of\nwireguard interfaces. This can take the form of a local file, a remote server,\nor anything else you can imagine.\n\nFor more information, please see the code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelus%2Fkeymaster-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelus%2Fkeymaster-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelus%2Fkeymaster-client/lists"}