{"id":21868733,"url":"https://github.com/davidk/wifiqr","last_synced_at":"2025-10-24T04:24:06.245Z","repository":{"id":57672149,"uuid":"199750117","full_name":"davidk/WifiQr","owner":"davidk","description":"A rustlang crate \u0026 utility to generate scannable QR codes for Wifi access","archived":false,"fork":false,"pushed_at":"2022-07-09T23:29:43.000Z","size":1570,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-14T01:48:56.002Z","etag":null,"topics":["qr-codes","rust","rust-crate","wifi"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/davidk.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":"2019-07-31T00:54:35.000Z","updated_at":"2024-01-24T23:37:45.000Z","dependencies_parsed_at":"2022-08-31T01:24:29.753Z","dependency_job_id":null,"html_url":"https://github.com/davidk/WifiQr","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/davidk/WifiQr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidk%2FWifiQr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidk%2FWifiQr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidk%2FWifiQr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidk%2FWifiQr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidk","download_url":"https://codeload.github.com/davidk/WifiQr/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidk%2FWifiQr/sbom","scorecard":{"id":326952,"data":{"date":"2025-08-11","repo":{"name":"github.com/davidk/WifiQr","commit":"98949f5ba3b5f387f876218f2de65118d0d0aeb8"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/rust.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":"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/rust.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/davidk/WifiQr/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/davidk/WifiQr/rust.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/rust.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/davidk/WifiQr/rust.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction 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":"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":"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":"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":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.0.8 not signed: https://api.github.com/repos/davidk/WifiQr/releases/71619552","Warn: release artifact 0.0.7 not signed: https://api.github.com/repos/davidk/WifiQr/releases/38150646","Warn: release artifact 0.0.6 not signed: https://api.github.com/repos/davidk/WifiQr/releases/24966378","Warn: release artifact 0.0.5 not signed: https://api.github.com/repos/davidk/WifiQr/releases/23138886","Warn: release artifact 0.0.4 not signed: https://api.github.com/repos/davidk/WifiQr/releases/20001096","Warn: release artifact 0.0.8 does not have provenance: https://api.github.com/repos/davidk/WifiQr/releases/71619552","Warn: release artifact 0.0.7 does not have provenance: https://api.github.com/repos/davidk/WifiQr/releases/38150646","Warn: release artifact 0.0.6 does not have provenance: https://api.github.com/repos/davidk/WifiQr/releases/24966378","Warn: release artifact 0.0.5 does not have provenance: https://api.github.com/repos/davidk/WifiQr/releases/23138886","Warn: release artifact 0.0.4 does not have provenance: https://api.github.com/repos/davidk/WifiQr/releases/20001096"],"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"}}]},"last_synced_at":"2025-08-18T02:41:10.773Z","repository_id":57672149,"created_at":"2025-08-18T02:41:10.774Z","updated_at":"2025-08-18T02:41:10.774Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279104339,"owners_count":26104487,"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-10-15T02:00:07.814Z","response_time":56,"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":["qr-codes","rust","rust-crate","wifi"],"created_at":"2024-11-28T05:15:06.675Z","updated_at":"2025-10-15T19:09:50.082Z","avatar_url":"https://github.com/davidk.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WifiQr\n\nThis Rust crate encodes Wifi credentials into a QR code. A [command-line interface](https://github.com/davidk/WifiQr/releases) is available for testing and basic use, too.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"/img/wifiqr-console.gif?raw=true\"/\u003e\u003c/p\u003e\n\n### Releases\n\nTo use WifiQr's command-line implementation, download a pre-built binary from the [releases tab](https://github.com/davidk/WifiQr/releases).\n\n### Utility usage\n\n\tUSAGE:\n\t    wifiqr [ --ssid (ssid) ] [ --password (password) | --ask ]\n\t            [ --encr encryption type (default:wpa2) ]\n\t            [ --imagefile (output_name.png) | --svg | --svgfile (output_name.svg) ]\n\t\n\tFLAGS:\n\t        --hidden      Optional: Indicate whether or not the SSID is hidden\n\t        --svg         Emit the QR code as an SVG (to standard output)\n\t        --console     Print the QR code out to the console\n\t    -d, --debug       Display some extra debugging output\n\t    -a, --ask         Ask for password instead of getting it through the command-line\n\t        --ask-echo    Ask for password while displaying input on the console\n\t        --quote       If the SSID or password could be mistaken for a hexadecimal value, \n\t                                          this option will add double-quotes around the SSID and password\n\t    -h, --help        Prints help information\n\t    -V, --version     Prints version information\n\t\n\tOPTIONS:\n\t        --ssid \u003cssid\u003e               Sets the WiFi SSID\n\t        --password \u003cpassword\u003e       Sets the WiFi password [default: ]\n\t        --encr \u003cencryption\u003e         The WiFi's encryption type (wpa, wpa2, nopass) [default: wpa2]\n\t        --scale \u003cscale\u003e             QR code scaling factor [default: 10]\n\t        --quietzone \u003cquiet_zone\u003e    QR code: The size of the quiet zone/border to apply to the final QR code [default:\n\t                                    2]\n\t        --imagefile \u003cimage_file\u003e    The name of the file to save to (e.g. --imagefile qr.png). Formats: [png, jpg, bmp]\n\t        --svgfile \u003csvg_file\u003e        Save the QR code to a file (SVG formatted)\n\n### Crate\n\nThis crate is available on [crates.io](https://crates.io/crates/wifiqr). Please be sure to pin the version you're using to a specific release (or commit), to avoid any changes that may break your application (efforts will be made to ensure that this is not the case).\n\n```rust\nextern crate wifiqr;\n\nfn main() {\n    let quiet_zone = 5;\n    let config = wifiqr::code::auth(\n        Some(\"ssid\"),       // Network name (ssid)\n        Some(\"password\"),   // Network password/passphrase\n        Some(\"wpa2\"),       // WPA | WPA2 | WEP\n        false,              // Hidden SSID (true | false)\n        false,              // SSID needs to be quoted (true | false)\n    );\n\n    let encoding = wifiqr::code::encode(\u0026config).expect(\"There was a problem generating the QR code\");\n\n    // this passes the svg output from the QR encoder back\n    println!(\"{}\", wifiqr::code::make_svg(\u0026encoding));\n\n    // this prints a qr code to the console\n    wifiqr::code::console_qr(\u0026encoding, quiet_zone);\n}\n\n```\n\n#### Building\n\nPre-built releases are provided on GitHub, but for development, or to build your own from source (after installing the [Rust toolchain](https://www.rust-lang.org/tools/install):\n\n\tcargo build --release\n\n### Information on QR codes as used in WI-FI authentication\n\n* [Format documentation, from zxing/zxing](https://github.com/zxing/zxing/wiki/Barcode-Contents)\n\n### Crates Used\n\n* [qrcodegen, via project nayuki](https://docs.rs/crate/qrcodegen/1.4.0)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidk%2Fwifiqr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidk%2Fwifiqr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidk%2Fwifiqr/lists"}