The core for your package manager, minus the dependency graph components. Features: download, verify, and extract.
By default—for HTTP, HTTPS, and FTP—this uses libfetch on FreeBSD; wininet on Windows; and libcurl everywhere else. Override with -DUSE_LIBCURL or -DUSE_LIBFETCH.
By default—for MD5, SHA256, SHA512—this uses wincrypt on Windows; and OpenSSL everywhere else. Note that on macOS this uses the builtin CommonCrypto/CommonDigest.h header, and on OpenBSD it uses LibreSSL; however in both of these cases it's the OpenSSL API with different headers. Override with -DUSE_OPENSSL.
By default—for crc32c—this uses rhash if available (also giving access to: CRC32, MD4, MD5, SHA1, SHA256, SHA512, SHA3, AICH, ED2K, DC++ TTH, BitTorrent BTIH, Tiger, GOST R 34.11-94, GOST R 34.11-2012, RIPEMD-160, HAS-160, EDON-R, and Whirlpool); otherwise uses included crc32c implementation. Override with -DUSE_CRC32C.
By default—for decompression—this uses compressapi.h on Windows; then, in order of precedence tries: libarchive; zlib; or downloads miniz.
Supports:
- Linux
- macOS
- Windows
- Solaris/OpenSolaris/illumos
- BSD
- Extremely portable C code (ANSI C: C89)
- link with different libraries, including those built in to your OS
- very small executable size (thanks to above)
- fast
- simple API, easy to integrate in your C project (or really any language, they all have nice FFI back to C or a C intermediary language)
- default cipher selection >= TLS 1.2
Dynamically links to shared libraries, defaulting to what's already installed on your OS by default.
If your OS doesn't have the dependency, an optimised dependency-free version will be add_library'd and depended upon.
† default on that OS
* WiP, not usable yet
| API | Package enable flag | OS support |
|---|---|---|
wincrypt.h |
USE_WINCRYPT |
Windows † |
| OpenSSL | USE_COMMON_CRYPTO |
macOS † |
| OpenSSL | USE_LIBRESSL |
All that LibreSSL supports |
| OpenSSL | USE_OPENSSL |
All that OpenSSL supports; default † on non macOS and Windows |
(will fallback to checksum library if undefined and only hashing is required and checksum library defined isn't CRC32C)
| API | Package enable flag | OS support |
|---|---|---|
| WinINet | USE_WININET |
Windows † |
| libfetch | USE_LIBFETCH |
FreeBSD † & derivatives; other OS support WiP (try BUILD_FREEBSD_LIBFETCH) |
* OpenBSD's ftp |
USE_OPENBSD_FTP |
OpenBSD † (try BUILD_OPENBSD_FTP) |
| libcurl | USE_LIBCURL |
All that curl supports; default † on non macOS and Windows |
| API | Package enable flag | OS support |
|---|---|---|
* compressapi.h |
USE_WINCOMPRESSAPI |
Windows † |
| * zlib | USE_ZLIB |
All that zlib supports; default † (if installed) on macOS, Linux, BSD, and SunOS |
| * libarchive | USE_LIBARCHIVE |
All that libarchive supports |
| miniz with zip API | USE_MINIZ |
All that miniz + zip supports; default † fallback |
Note that most checksum libraries are crypto libraries, so working with these APIs isn't required for libacquire:
| API | Package enable flag | OS support |
|---|---|---|
* acquire_crc32c.h |
USE_CRC32C |
All |
| * RHash (Recursive Hasher) | USE_LIBRHASH |
All; † fallback to USE_CRC32C |
Dockerfiles are provided for convenience, try them out, e.g., by running:
docker build . -f alpine.Dockerfile --tag libacquire:alpine_latest
docker run libacquire:alpine_latest#!/usr/bin/env sh
function acquire () {
target_directory="$1"
url="$2"
checksum="$3"
prev_wd="`pwd`"
filename=`echo "$url" | grep -oE "[^/]+$"`
cd "$target_directory"
curl -sS --tlsv1.2 -O "$url"
printf '%s %s' "$checksum" "$filename" | sha256sum -c --quiet
tar xf "$filename"
cd "$prev_wd"
}
acquire \
'/tmp' \
'https://nodejs.org/download/release/v12.16.3/node-v12.16.3-headers.tar.xz' \
'27169e5284a7bc2783bfb79bb80f69453cc59d2d5ca3d5d22265826370475cad'- Works in most shells.
- Easy to read
- Can be edited easily
- Doesn't work on Windows
- Everyone has their own equivalent script as above; followed by
install,cpio, or just manuallymkdir -p,cp,chown, andchmod - Needs to be edited for each new version of Node.js (still a disadvantage of libacquire; but wait till you see the
nvmstyle independent package managers built with libacquire!) - Everyone has their favourite
curl/wget/fetchcommand, rarely do they set the ciphers (TLS 1.2 or higher is now the recommendation) - Can be edited easily
Want different options for libcurl, OpenSSL, or any of the other dependencies? - CMake has a CACHEing mechanism. - You should be able to explicitly include your settings before including libacquire, and it'll use the one already included (with your custom settings).
- CMake (3.19 or later)
- C compiler (any that work with CMake, and were released within the last 30 years)
- Crypto, HTTPS, and unarchiving library (see above for what to override and OS support; defaults to OS builtin API)
$ mkdir build && cd build
$ cmake ..
$ cmake --build .(alternatively to system search, you can also use vcpkg by explicitly overriding -DCMAKE_TOOLCHAIN_FILE)
Care is taken, starting with:
- header only modular functionality in separate .h files
…these are created:
- amalgamation header with all header content added to one;
- separate .h and .c files to enable common use-cases;
- amalgamation header with just prototypes, .c content expected to be contained in a shared library.
Generated with docopt, use python -m pip install docopt-c then:
$ python -m docopt_c '.docopt' -o 'libacquire/acquire/cli'- https://github.com/SamuelMarks/curl-simple-https
- https://github.com/SamuelMarks/cdd-c
- https://verMan.io
- https://github.com/offscale/postgres-version-manager-go
- "version-manager-rs" suffixed and [verman-schema-rs]
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.