{"id":48320311,"url":"https://github.com/anarkiwi/faucetconfrpc","last_synced_at":"2026-04-05T00:39:06.593Z","repository":{"id":37038222,"uuid":"273103571","full_name":"anarkiwi/faucetconfrpc","owner":"anarkiwi","description":"An RPC for Faucet Config Files","archived":false,"fork":false,"pushed_at":"2026-03-26T20:57:43.000Z","size":9490,"stargazers_count":9,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-27T08:33:09.124Z","etag":null,"topics":["faucet","grpc","grpc-go","grpc-python","rpc","sdn"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anarkiwi.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-18T00:13:39.000Z","updated_at":"2026-03-26T20:55:51.000Z","dependencies_parsed_at":"2023-09-24T10:12:55.968Z","dependency_job_id":"b7219d25-2a53-4d38-be01-03e9d207fa37","html_url":"https://github.com/anarkiwi/faucetconfrpc","commit_stats":null,"previous_names":["cyberreboot/faucetconfrpc","anarkiwi/faucetconfrpc"],"tags_count":98,"template":false,"template_full_name":null,"purl":"pkg:github/anarkiwi/faucetconfrpc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anarkiwi%2Ffaucetconfrpc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anarkiwi%2Ffaucetconfrpc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anarkiwi%2Ffaucetconfrpc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anarkiwi%2Ffaucetconfrpc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anarkiwi","download_url":"https://codeload.github.com/anarkiwi/faucetconfrpc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anarkiwi%2Ffaucetconfrpc/sbom","scorecard":{"id":64957,"data":{"date":"2025-08-11","repo":{"name":"github.com/IQTLabs/faucetconfrpc","commit":"7a4d6a2ee03dcb9432741011b9473786b18e3928"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/2 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":"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":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/docker.yaml:1","Warn: no topLevel permission defined: .github/workflows/pypi.yaml:1","Warn: no topLevel permission defined: .github/workflows/stale.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":"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: Apache License 2.0: 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":"Pinned-Dependencies","score":1,"reason":"dependency not pinned by hash detected -- score normalized to 1","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/docker.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/docker.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/docker.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/pypi.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/pypi.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/stale.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/test.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/IQTLabs/faucetconfrpc/test.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile.server:1","Warn: containerImage not pinned by hash: Dockerfile.server:14: pin your Docker image by updating ubuntu:noble to ubuntu:noble@sha256:a08e551cb33850e4740772b38217fc1796a66da2506d312abe51acda354ff061","Warn: containerImage not pinned by hash: certstrap/Dockerfile:1","Warn: containerImage not pinned by hash: certstrap/Dockerfile:9: pin your Docker image by updating alpine:3.22 to alpine:3.22@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8c44de311d1","Warn: downloadThenRun not pinned by hash: Dockerfile.server:13","Warn: pipCommand not pinned by hash: Dockerfile.server:13","Warn: goCommand not pinned by hash: certstrap/Dockerfile:4","Warn: goCommand not pinned by hash: .github/workflows/test.yml:50","Warn: goCommand not pinned by hash: .github/workflows/test.yml:51","Warn: goCommand not pinned by hash: .github/workflows/test.yml:52","Warn: goCommand not pinned by hash: .github/workflows/test.yml:53","Info:   4 out of   7 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned","Info:   0 out of   4 containerImage dependencies pinned","Info:   0 out of   1 downloadThenRun dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned","Info:   1 out of   6 goCommand 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":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"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":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/docker.yaml:9"],"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"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 30 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-15T02:24:25.861Z","repository_id":37038222,"created_at":"2025-08-15T02:24:25.862Z","updated_at":"2025-08-15T02:24:25.862Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31420475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T00:25:07.052Z","status":"ssl_error","status_checked_at":"2026-04-05T00:25:05.923Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["faucet","grpc","grpc-go","grpc-python","rpc","sdn"],"created_at":"2026-04-05T00:39:05.867Z","updated_at":"2026-04-05T00:39:06.571Z","avatar_url":"https://github.com/anarkiwi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# faucetconfrpc\n\nAn RPC server/client for Faucet YAML config files.\n\n## Overview\n\nThe Faucet SDN controller obtains its configuration from at least one YAML file,\ngenerally /etc/faucet/faucet.yaml (which may include others).  Faucet can be\nconfigured to notice a change in those configuration files itself, or upon\nreceiving a HUP signal.  An operator, an automated process, or a combination\nof both must provide the entire configuration and make it self-consistent.\n\nHowever, an application relying on Faucet may just want to make simple changes - such\nas to mirror a port to another port, or to an apply an ACL - and not have to\nunderstand/parse/be responsible for the entire configuration.  faucetconfrpc\nprovides such high level RPCs and will probably provide more ongoing.  Applications\nmay also use faucetconfrpc to manage entire configuration files at once,\nso can serve both high level and low level needs.\n\nfaucetconfrpc therefore provides a similar role for Faucet, to that provided by\novsdb-server for OVS (providing RPC access, and some common high and low level\noperations at the command line).  Again like ovsdb-server, only one faucetconfrpc\nprocess can manage one set of Faucet configuration files at once.\n\nfaucetconfrpc requires mutual client-server certificate based authentication,\nusing gRPC.  RPC calls are authenticated and all clients operate at the same\nlevel of privilege.  faucetconfrpc can be restarted at any time without\ndisturbing running Faucets.  faucetconfrpc validates all configuration changes\nusing Faucet's own configuration parser library before submitting them.\n\n## Example usage\n\nIn one terminal, having already created keys for client and server in `/tmp/keydir`, start the server with an example config file:\n\n```cat\u003c\u003cEOD\n$ mkdir -p /tmp/conf_dir\n$ cat\u003c\u003cEOD\u003e/tmp/conf_dir/faucet.yaml\n dps:\n   ovs:\n     dp_id: 0x1\n     hardware: Open vSwitch\n     interfaces:\n       1:\n          native_vlan: 100\nEOD\n$ docker build -f Dockerfile.server . -t iqtlabs/faucetconfrpc\n$ docker run -v /tmp/keydir:/keydir -v /tmp/conf_dir:/conf_dir -p 59999:59999/tcp iqtlabs/faucetconfrpc:latest --key=/keydir/localhost.key --cert=/keydir/localhost.crt --cacert=/keydir/ca.crt --host=0.0.0.0 --config_dir=/conf_dir\n```\n\nIn another terminal, having run `pip3 install faucetconfrpc`:\n\n```\n$ faucetconfrpc_client.py get_config_file --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n{'dps': {'ovs': {'dp_id': 1, 'hardware': 'Open vSwitch', 'interfaces': {1: {'native_vlan': 100}}}}}\n$ faucetconfrpc_client.py set_config_file config_yaml='{dps: {ovs: {interfaces: {1: {native_vlan: 200}}}}}' merge=true --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n\n$ faucetconfrpc_client.py get_config_file --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n{'dps': {'ovs': {'dp_id': 1, 'hardware': 'Open vSwitch', 'interfaces': {1: {'native_vlan': 200}}}}}\n\n$ faucetconfrpc_client.py set_config_file config_yaml='{dps: {ovs: {interfaces: {2: {native_vlan: 100}}}}}' merge=true --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n\n$ faucetconfrpc_client.py get_config_file config_filename='faucet.yaml' --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n{'dps': {'ovs': {'dp_id': 1, 'hardware': 'Open vSwitch', 'interfaces': {1: {'native_vlan': 200}, 2: {'native_vlan': 100}}}}}\n$ faucetconfrpc_client.py del_config_from_file config_filename='faucet.yaml' config_yaml_keys='[dps, ovs, interfaces, 1]' --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n\n$ faucetconfrpc_client.py get_config_file config_filename='faucet.yaml' --key=/tmp/keydir/client.key --cert=/tmp/keydir/client.crt --cacert=/tmp/keydir/ca.crt\n{'dps': {'ovs': {'dp_id': 1, 'hardware': 'Open vSwitch', 'interfaces': {2: {'native_vlan': 100}}}}}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanarkiwi%2Ffaucetconfrpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanarkiwi%2Ffaucetconfrpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanarkiwi%2Ffaucetconfrpc/lists"}