{"id":13420439,"url":"https://github.com/libimobiledevice/libusbmuxd","last_synced_at":"2025-05-16T14:06:38.693Z","repository":{"id":10659733,"uuid":"12892000","full_name":"libimobiledevice/libusbmuxd","owner":"libimobiledevice","description":"A client library to multiplex connections from and to iOS devices","archived":false,"fork":false,"pushed_at":"2025-02-16T22:49:01.000Z","size":317,"stargazers_count":631,"open_issues_count":29,"forks_count":280,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-05-13T09:43:45.926Z","etag":null,"topics":["c","ios","iproxy","library","usb","usbmuxd"],"latest_commit_sha":null,"homepage":"https://libimobiledevice.org","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libimobiledevice.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-09-17T09:59:04.000Z","updated_at":"2025-05-06T03:07:30.000Z","dependencies_parsed_at":"2024-01-06T01:06:30.084Z","dependency_job_id":"23d89dcc-e391-4443-a196-ade36be0c199","html_url":"https://github.com/libimobiledevice/libusbmuxd","commit_stats":{"total_commits":202,"total_committers":15,"mean_commits":"13.466666666666667","dds":"0.31188118811881194","last_synced_commit":"4e14ae142f998bfdcad71f3099c0e4aa3628354c"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibusbmuxd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibusbmuxd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibusbmuxd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libimobiledevice%2Flibusbmuxd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libimobiledevice","download_url":"https://codeload.github.com/libimobiledevice/libusbmuxd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["c","ios","iproxy","library","usb","usbmuxd"],"created_at":"2024-07-30T22:01:33.707Z","updated_at":"2025-05-16T14:06:38.637Z","avatar_url":"https://github.com/libimobiledevice.png","language":"C","funding_links":[],"categories":["TODO scan for Android support in followings","Uncategorized","C","Tools","HarmonyOS"],"sub_categories":["Uncategorized","Dynamic Analysis Tools","Windows Manager"],"readme":"# libusbmuxd\n\n*A client library for applications to handle usbmux protocol connections with iOS devices.*\n\n![](https://github.com/libimobiledevice/libusbmuxd/actions/workflows/build.yml/badge.svg)\n\n## Table of Contents\n- [Features](#features)\n- [Building](#building)\n  - [Prerequisites](#prerequisites)\n    - [Linux (Debian/Ubuntu based)](#linux-debianubuntu-based)\n    - [macOS](#macos)\n    - [Windows](#windows)\n  - [Configuring the source tree](#configuring-the-source-tree)\n  - [Building and installation](#building-and-installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [Links](#links)\n- [License](#license)\n- [Credits](#credits)\n\n## Features\n\nThis project is a client library to multiplex connections from and to iOS\ndevices alongside command-line utilities.\n\nIt is primarily used by applications which use the [libimobiledevice](https://github.com/libimobiledevice/)\nlibrary to communicate with services running on iOS devices.\n\nThe library does not establish a direct connection with a device but requires\nconnecting to a socket provided by the usbmuxd daemon.\n\nThe usbmuxd daemon is running upon installing iTunes on Windows and Mac OS X.\n\nThe [libimobiledevice project](https://github.com/libimobiledevice/) provides an open-source reimplementation of\nthe [usbmuxd daemon](https://github.com/libimobiledevice/usbmuxd.git/) to use on Linux or as an alternative to communicate with\niOS devices without the need to install iTunes.\n\nSome key features are:\n\n- **Protocol:** Provides an interface to handle the usbmux protocol\n- **Port Proxy:** Provides the `iproxy` utility to proxy ports to the device\n- **Netcat:** Provides the `inetcat` utility to expose a raw connection to the device\n- **Cross-Platform:** Tested on Linux, macOS, Windows and Android platforms\n- **Flexible:** Allows using the open-source or proprietary usbmuxd daemon\n\nFurthermore the Linux build optionally provides support using inotify if\navailable.\n\n## Building\n\n### Prerequisites\n\nYou need to have a working compiler (gcc/clang) and development environent\navailable. This project uses autotools for the build process, allowing to\nhave common build steps across different platforms.\nOnly the prerequisites differ and they are described in this section.\n\nlibusbmuxd requires [libplist](https://github.com/libimobiledevice/libplist) and [libimobiledevice-glue](https://github.com/libimobiledevice/libimobiledevice-glue). On Linux, it also requires [usbmuxd](https://github.com/libimobiledevice/usbmuxd) installed on the system, while macOS has its own copy and on Windows AppleMobileDeviceSupport package provides it.\nCheck [libplist's Building](https://github.com/libimobiledevice/libplist?tab=readme-ov-file#building) and [libimobiledevice-glue's Building](https://github.com/libimobiledevice/libimobiledevice-glue?tab=readme-ov-file#building)\nsection of the respective README on how to build them. Note that some platforms might have them as a package.\n\n#### Linux (Debian/Ubuntu based)\n\n* Install all required dependencies and build tools:\n  ```shell\n  sudo apt-get install \\\n  \tbuild-essential \\\n  \tpkg-config \\\n  \tcheckinstall \\\n  \tgit \\\n  \tautoconf \\\n  \tautomake \\\n  \tlibtool-bin \\\n  \tlibplist-dev \\\n  \tlibimobiledevice-glue-dev \\\n  \tusbmuxd\n  ```\n  In case libplist-dev, libimobiledevice-glue-dev, or usbmuxd are not available, you can manually build and install them. See note above.\n\n#### macOS\n\n* Make sure the Xcode command line tools are installed. Then, use either [MacPorts](https://www.macports.org/)\n  or [Homebrew](https://brew.sh/) to install `automake`, `autoconf`, `libtool`, etc.\n\n  Using MacPorts:\n  ```shell\n  sudo port install libtool autoconf automake pkgconfig\n  ```\n\n  Using Homebrew:\n  ```shell\n  brew install libtool autoconf automake pkg-config\n  ```\n\n#### Windows\n\n* Using [MSYS2](https://www.msys2.org/) is the official way of compiling this project on Windows. Download the MSYS2 installer\n  and follow the installation steps.\n\n  It is recommended to use the _MSYS2 MinGW 64-bit_ shell. Run it and make sure the required dependencies are installed:\n\n  ```shell\n  pacman -S base-devel \\\n  \tgit \\\n  \tmingw-w64-x86_64-gcc \\\n  \tmake \\\n  \tlibtool \\\n  \tautoconf \\\n  \tautomake-wrapper \\\n  \tpkg-config\n  ```\n  NOTE: You can use a different shell and different compiler according to your needs. Adapt the above command accordingly.\n\n### Configuring the source tree\n\nYou can build the source code from a git checkout, or from a `.tar.bz2` release tarball from [Releases](https://github.com/libimobiledevice/libusbmuxd/releases).\nBefore we can build it, the source tree has to be configured for building. The steps depend on where you got the source from.\n\nSince libusbmuxd depends on other packages, you should set the pkg-config environment variable `PKG_CONFIG_PATH`\naccordingly. Make sure to use a path with the same prefix as the dependencies. If they are installed in `/usr/local` you would do\n\n```shell\nexport PKG_CONFIG_PATH=/usr/local/lib/pkgconfig\n```\n\n* **From git**\n\n  If you haven't done already, clone the actual project repository and change into the directory.\n  ```shell\n  git clone https://github.com/libimobiledevice/libusbmuxd\n  cd libusbmuxd\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./autogen.sh\n  ```\n\n* **From release tarball (.tar.bz2)**\n\n  When using an official [release tarball](https://github.com/libimobiledevice/libusbmuxd/releases) (`libusbmuxd-x.y.z.tar.bz2`)\n  the procedure is slightly different.\n\n  Extract the tarball:\n  ```shell\n  tar xjf libusbmuxd-x.y.z.tar.bz2\n  cd libusbmuxd-x.y.z\n  ```\n\n  Configure the source tree for building:\n  ```shell\n  ./configure\n  ```\n\nBoth `./configure` and `./autogen.sh` (which generates and calls `configure`) accept a few options, for example `--prefix` to allow\nbuilding for a different target folder. You can simply pass them like this:\n\n```shell\n./autogen.sh --prefix=/usr/local\n```\nor\n```shell\n./configure --prefix=/usr/local\n```\n\nOnce the command is successful, the last few lines of output will look like this:\n```\n[...]\nconfig.status: creating config.h\nconfig.status: executing depfiles commands\nconfig.status: executing libtool commands\n\nConfiguration for libusbmuxd 2.1.0:\n-------------------------------------------\n\n  Install prefix: .........: /usr/local\n  inotify support (Linux) .: no\n\n  Now type 'make' to build libusbmuxd 2.1.0,\n  and then 'make install' for installation.\n```\n\n## Usage\n\n### iproxy\n\nThis utility allows binding local TCP ports so that a connection to one (or\nmore) of the local ports will be forwarded to the specified port (or ports) on\na usbmux device.\n\nBind local TCP port 2222 and forward to port 22 of the first device connected\nvia USB:\n```shell\niproxy 2222:22\n```\n\nThis would allow using ssh with `localhost:2222` to connect to the sshd daemon\non the device. Please mind that this is just an example and the sshd daemon is\nonly available for jailbroken devices that actually have it installed.\n\nPlease consult the usage information or manual page for a full documentation of\navailable command line options:\n```shell\niproxy --help\nman iproxy\n```\n\n### inetcat\n\nThis utility is a simple netcat-like tool that allows opening a read/write\ninterface to a TCP port on a usbmux device and expose it via STDIN/STDOUT.\n\nUse ssh ProxyCommand to connect to a jailbroken iOS device via SSH:\n```shell\nssh -oProxyCommand=\"inetcat 22\" root@localhost\n```\n\nPlease consult the usage information or manual page for a full documentation of\navailable command line options:\n```shell\ninetcat --help\nman inetcat\n```\n\n### Environment\n\nThe environment variable `USBMUXD_SOCKET_ADDRESS` allows to change the location\nof the usbmuxd socket away from the local default one.\n\nAn example of using an utility from the libimobiledevice project with an usbmuxd\nsocket exposed on a port of a remote host:\n```shell\nexport USBMUXD_SOCKET_ADDRESS=192.168.179.1:27015\nideviceinfo\n```\n\nThis sets the usbmuxd socket address to `192.168.179.1:27015` for applications\nthat use the libusbmuxd library.\n\n## Contributing\n\nWe welcome contributions from anyone and are grateful for every pull request!\n\nIf you'd like to contribute, please fork the `master` branch, change, commit and\nsend a pull request for review. Once approved it can be merged into the main\ncode base.\n\nIf you plan to contribute larger changes or a major refactoring, please create a\nticket first to discuss the idea upfront to ensure less effort for everyone.\n\nPlease make sure your contribution adheres to:\n* Try to follow the code style of the project\n* Commit messages should describe the change well without being too short\n* Try to split larger changes into individual commits of a common domain\n* Use your real name and a valid email address for your commits\n\n## Links\n\n* Homepage: https://libimobiledevice.org/\n* Repository: https://github.com/libimobiledevice/libusbmuxd.git\n* Repository (Mirror): https://git.libimobiledevice.org/libusbmuxd.git\n* Issue Tracker: https://github.com/libimobiledevice/libusbmuxd/issues\n* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel\n* Twitter: https://twitter.com/libimobiledev\n\n## License\n\nThis library is licensed under the [GNU Lesser General Public License v2.1](https://www.gnu.org/licenses/lgpl-2.1.en.html),\nalso included in the repository in the `COPYING` file.\n\nThe utilities `iproxy` and `inetcat` are licensed under the [GNU General Public License v2.0](https://www.gnu.org/licenses/gpl-2.0.en.html).\n\n## Credits\n\nApple, iPhone, iPad, iPod, iPod Touch, Apple TV, Apple Watch, Mac, iOS,\niPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.\n\nThis project is an independent software library and has not been authorized,\nsponsored, or otherwise approved by Apple Inc.\n\nREADME Updated on: 2024-10-22\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibusbmuxd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibimobiledevice%2Flibusbmuxd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibimobiledevice%2Flibusbmuxd/lists"}