{"id":13449888,"url":"https://github.com/aequitas/macos-menubar-wireguard","last_synced_at":"2025-04-13T04:59:21.016Z","repository":{"id":51487555,"uuid":"144458665","full_name":"aequitas/macos-menubar-wireguard","owner":"aequitas","description":"macOS menubar icon for WireGuard/wg-quick","archived":false,"fork":false,"pushed_at":"2025-01-31T14:57:10.000Z","size":2999,"stargazers_count":241,"open_issues_count":5,"forks_count":40,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-13T04:59:14.128Z","etag":null,"topics":["macos","statusbar","vpn","wireguard"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aequitas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=53726VWZV2DFL\u0026item_name=Github\u0026currency_code=EUR\u0026source=url"]}},"created_at":"2018-08-12T10:48:06.000Z","updated_at":"2025-04-12T04:16:31.000Z","dependencies_parsed_at":"2022-08-21T10:40:17.004Z","dependency_job_id":null,"html_url":"https://github.com/aequitas/macos-menubar-wireguard","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aequitas%2Fmacos-menubar-wireguard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aequitas%2Fmacos-menubar-wireguard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aequitas%2Fmacos-menubar-wireguard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aequitas%2Fmacos-menubar-wireguard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aequitas","download_url":"https://codeload.github.com/aequitas/macos-menubar-wireguard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248665758,"owners_count":21142123,"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","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":["macos","statusbar","vpn","wireguard"],"created_at":"2024-07-31T07:00:18.218Z","updated_at":"2025-04-13T04:59:20.979Z","avatar_url":"https://github.com/aequitas.png","language":"Swift","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=53726VWZV2DFL\u0026item_name=Github\u0026currency_code=EUR\u0026source=url"],"categories":["Uncategorized","Swift","Projects"],"sub_categories":["Uncategorized","User Interface"],"readme":"# WireGuardStatusbar\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/66efb09de55fafe897e0/maintainability)](https://codeclimate.com/github/aequitas/macos-menubar-wireguard/maintainability)\n[![Build Status](https://travis-ci.org/aequitas/macos-menubar-wireguard.svg?branch=master)](https://travis-ci.org/aequitas/macos-menubar-wireguard)\n\n## Notice\n There is now an **official** WireGuard application that supersedes this App. You can find it at: https://www.wireguard.com/install/ or directly download it from the AppStore: https://itunes.apple.com/us/app/wireguard/id1451685025?ls=1\u0026mt=12\n\n The WireGuardStatusbar application will remain available and might get updates/bugfixes but not develop any new features. You might still want to use it if you run a macOS prior to 10.14.\n\n## Introduction\n\nThis is a macOS statusbar item (aka menubar icon) that wraps wg-quick.\n\n![Screenshot](Misc/demo.png)\n\n## Features\n\n- Sit in your menubar\n- Indicate if tunnels are enabled\n- Bring tunnel up/down via one click\n- ~~Fail miserably when brew/wg-quick is not installed or permissions on files are incorrect~~\n\n## Installation\n\n### Manually\n\n- Follow the instruction to [install WireGuard for macOS](https://www.wireguard.com/install/)\n- Create a tunnel configuration file (eg: `/opt/homebrew/etc/wireguard/utun1.conf`)\n- Download this App from [Releases](https://github.com/aequitas/macos-menubar-wireguard/releases)\n- Open the .dmg and copy the Application to where you like (eg: '/Applications')\n- The next bit is needed because I don't have a Apple Developer account to properly sign the binary. If you don't like it consider building and signing the application yourself.\n  - Start the App and get a dialog indicating the app is not signed\n  - Go to: Preferences-\u003eSecurity \u0026 Privacy-\u003eGeneral and click \"Open Anyway\"\n\n#### Specify brew location\n\nIn case you have brew installed in some non-default directory [since 1.16](https://github.com/aequitas/macos-menubar-wireguard/releases/tag/1.16) you can specify `brew` or `wg-quick` path.\n\nTo set `brew` path:\n\n`sudo defaults write WireGuardStatusbarHelper brewPrefix /opt/local/`\n\nTo set the path to `wg-quick` binary:\n\n`sudo defaults write WireGuardStatusbarHelper wgquickBinPath /opt/local/bin/wg-quick`\n\n## Building \u0026 Testing\n\nAutomation scripting is provided in this repository to make development a little easier. Primary development using Xcode is supported/preferred but some actions (integration testing, distribution build) are only available using `make`.\n\nTo test the project and check code quality run:\n\n    make test-unit\n\nIntegration tests require preparation and will ask for a `sudo` password to install a test configuration file in `/etc/wireguard`:\n\n    make test-integration\n\nCode formatting should preferably by done by computers. To auto correct most violations run (this is also run before each `make test` or `make check`):\n\n    make fix\n\nTo completely verify/test the project, build a distributable `.dmg` and install to `/Applications` simply run:\n\n    make\n\nOr explore `make` with tab completion for other options.\n\n## Architecture/Security\n\n- This application is split into two parts. The Application and a [Privileged Helper](https://developer.apple.com/library/archive/documentation/Security/Conceptual/SecureCodingGuide/Articles/AccessControl.html).\n- The App will sit in the menubar after launching and handle all UI interaction and logic.\n- Whenever the App needs to perform actions requiring Administrator privileges (eg: start/stop tunnel, read configurations) it will communicate with the Helper via XPC to have these actions performed.\n- The Helper is installed as a [Privileged Launchd daemon](https://developer.apple.com/documentation/servicemanagement/1431078-smjobbless?language=objc) during the startup of the App. The user will be prompted for credentials during this action.\n- Logic/responsability in the Helper is kept to a minimum and communication between the App and the Helper is in simple primitives to reduce attack surface of the Helper.\n- The Helper should not allow an unprivileged attacker to perform any actions via the XPC that would not be possible to perform when using the App.\n- Both the App and the Helper are signed and these signatures will be verified on Helper installation.\n- The Helper will only run during the runtime of the Application.\n- The Helper notifies the App on any change in the WireGuard configuration/runtime state. The App will then query the Helper to allow rebuilding its menus.\n\n## License\n\nThis software as a whole is licensed under GPL-3.0\n\n\"WireGuard\" and the \"WireGuard\" logo are registered trademarks of Jason A. Donenfeld.\n\n## Todo/Readmap\n\n- Tunnel connectivity status\n- Tunnel configuration editor\n- Key management (via keychain)\n- Tunnel configuration augmentation (groups, alt. names, etc)\n- read configuration using `wg`\n- More tunnel statistics (privilegedhelper)\n- Recent tunnels on top option\n- Active tunnels on top option\n- Start tunnels at startup\n- Add application to startup items\n- Bundle WireGuard (wireguard-go/wg-quick/bash4)/Drop `wg-quick` for custom route creations (to drop bash4 as requirements and enable advances routing options like excluding local networks from 0.0.0.0/0).\n- Help menu\n- Developer ID signing\n- Update checking\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faequitas%2Fmacos-menubar-wireguard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faequitas%2Fmacos-menubar-wireguard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faequitas%2Fmacos-menubar-wireguard/lists"}