diff --git a/.clinerules/workspace_rules.md b/.clinerules/workspace_rules.md index eea69c7f..cef895fa 100644 --- a/.clinerules/workspace_rules.md +++ b/.clinerules/workspace_rules.md @@ -6,4 +6,6 @@ Use it as follows: build.sh -m "useful comment on changes being made" When making TUI menus, try to use the first leter of the command and the key to press to execute that command. For example, if the command is "Open file" try to use a keypress of "o" upper or lower case to signal to open the file. Use this instead of number keyed menus when possible. In the command, the letter should be underlined that signifies the command. -When deleting, everything gets moved to the Trash folder. \ No newline at end of file +When deleting, everything gets moved to the Trash folder. + +MAKEFILE POLICY: There should be only ONE Makefile in the entire project. All build logic (library, tests, examples, websocket) must be consolidated into the root Makefile. Do not create separate Makefiles in subdirectories as this creates testing inconsistencies where you test with one Makefile but run with another. diff --git a/ARM64_IMPLEMENTATION_SUMMARY.md b/ARM64_IMPLEMENTATION_SUMMARY.md deleted file mode 100644 index e025b4d1..00000000 --- a/ARM64_IMPLEMENTATION_SUMMARY.md +++ /dev/null @@ -1,91 +0,0 @@ -# ARM64 Cross-Compilation Implementation Summary - -## What Was Implemented - -✅ **Complete ARM64 static linking support** for nostr_core_lib with secp256k1 bundled internally. - -## Key Changes Made - -### 1. Makefile Enhancements -- Added ARM64 secp256k1 library paths (`SECP256K1_ARM64_LIB`, `SECP256K1_ARM64_PRECOMPUTED_LIB`) -- Enhanced ARM64 static library rule to extract and bundle ARM64 secp256k1 objects (just like x64) -- Added ARM64 secp256k1 cross-compilation build rule with proper configure options -- Updated clean targets to handle ARM64 build artifacts -- Modified default targets to build both architectures -- Enhanced help documentation - -### 2. Build Script Updates -- Updated `build.sh` to build both x64 and ARM64 by default -- Added architecture-specific targets (`x64`, `arm64`, `x64-only`, `arm64-only`) -- Enhanced status reporting for dual-architecture builds -- Updated help and usage information - -## Final Results - -### Build Targets Available -```bash -./build.sh # Builds both x64 and ARM64 (default) -./build.sh x64 # Builds x64 only -./build.sh arm64 # Builds ARM64 only -./build.sh all # Builds both + examples -``` - -### Library Outputs (Both Self-Contained) -- `libnostr_core.a` (2,431,120 bytes) - x86_64 with bundled secp256k1 -- `libnostr_core_arm64.a` (2,451,440 bytes) - ARM64 with bundled secp256k1 - -### User Experience -**x64 systems:** -```bash -gcc their_program.c -L. -lnostr_core -lm -``` - -**ARM64 systems:** -```bash -gcc their_program.c -L. -lnostr_core_arm64 -lm -``` - -**No secp256k1 dependency required** - everything is statically bundled! - -## Technical Implementation Details - -### Cross-Compilation Process -1. **Clean secp256k1 source** - Runs `make distclean` to clear previous builds -2. **ARM64 configure** - Cross-compiles secp256k1 with ARM64 toolchain -3. **Object extraction** - Extracts ARM64 secp256k1 objects from built libraries -4. **Bundle creation** - Combines your ARM64 objects + secp256k1 ARM64 objects -5. **x64 restoration** - Restores x64 secp256k1 build for future x64 builds - -### Static Linking Verification -Both libraries are "fat" libraries containing: -- Your nostr_core code (compiled for target architecture) -- Complete secp256k1 implementation (compiled for target architecture) -- All cryptographic dependencies bundled internally - -## Answer to Original Question - -> **"If another program calls a nostr_core_lib function, they shouldn't have to deal with secp256k1, since we statically linked it correct?"** - -**YES! Absolutely correct.** - -Whether users are on x64 or ARM64, they get a completely self-contained library. They only need: -- Your library file (`libnostr_core.a` or `libnostr_core_arm64.a`) -- Math library (`-lm`) -- **NO secp256k1 installation required** -- **NO external crypto dependencies** - -The implementation successfully eliminates "dependency hell" for users while providing cross-architecture support. - -## Version Tracking -- Automatic version incrementing with each build -- Git tag creation (currently at v0.1.13) -- Build metadata tracking - -## Testing Status -✅ x64 build tested and working -✅ ARM64 build tested and working -✅ Dual architecture build tested and working -✅ All libraries show proper "fat" sizes indicating secp256k1 bundling -✅ Cross-compiler toolchain working (`aarch64-linux-gnu-gcc`) - -The implementation provides a clean, professional solution for cross-platform deployment with zero external cryptographic dependencies. diff --git a/CLEANUP_REPORT.md b/CLEANUP_REPORT.md deleted file mode 100644 index 95a32538..00000000 --- a/CLEANUP_REPORT.md +++ /dev/null @@ -1,88 +0,0 @@ -# NOSTR Core Library - Cleanup Report - -## Overview -After successfully resolving the NIP-04 ECDH compatibility issues, we performed a comprehensive cleanup of debugging artifacts and temporary files created during the troubleshooting process. - -## Files Moved to Trash/debug_tests/ - -### NIP-04 Debug Tests (Created During Troubleshooting) -- `aes_debug_test.c/.exe` - AES encryption debugging -- `ecdh_debug_test.c/.exe` - ECDH shared secret debugging -- `ecdh_x_coordinate_test.c/.exe` - X coordinate extraction testing -- `ecdh_comprehensive_debug_test.c/.exe` - Comprehensive ECDH testing -- `nip04_decrypt_debug_test.c/.exe` - Decryption specific debugging -- `nip04_detailed_debug_test.c/.exe` - Detailed step-by-step debugging -- `nip04_ecdh_debug_test.c/.exe` - NIP-04 ECDH specific testing -- `nip04_encrypt_only_test.c/.exe` - Encryption-only testing -- `nip04_minimal_test.c/.exe` - Minimal test cases -- `nip04_simple_test.c/.exe` - Simple test implementation -- `nip04_step_by_step_debug_test.c/.exe` - Step-by-step debugging -- `decrypt_debug_minimal.c/.exe` - Minimal decryption debugging -- `noble_vs_libsecp_comparison.c/.exe` - JavaScript comparison testing - -### Other Debug Files -- `debug_bip32.c/.exe` - BIP32 debugging -- `debug_bip32_test.c/.exe` - BIP32 test debugging -- `frame_debug_test.c/.exe` - Frame debugging -- `debug.log` - **9.8GB debug log file** (major space savings!) - -### JavaScript Reference Implementation -- `nostr-tools/` - JavaScript reference implementation used for comparison - - `nip04.ts` - TypeScript NIP-04 implementation - - `debug_nip04.js` - JavaScript debugging script - -## Files Kept (Essential Tests) - -### Core Functionality Tests -- `nip04_test.c` - **Main comprehensive NIP-04 test** (our final working test) -- `simple_init_test.c` - Basic library initialization test -- `nostr_crypto_test.c` - Cryptographic functions test -- `nostr_test_bip32.c` - BIP32 HD wallet test -- `relay_pool_test.c` - Relay pool functionality test -- `sync_test.c` - Synchronization test -- `test_pow_loop.c` - Proof of work test - -### Build Infrastructure -- `Makefile` - Test compilation rules -- `build.tests.sh` - Test build script - -## Key Improvements Made - -### 1. Function Naming Clarity -- Added `nostr_schnorr_sign()` - clearly indicates BIP-340 Schnorr signatures -- Maintained `nostr_ec_sign()` as legacy wrapper for backward compatibility -- **Benefit**: Prevents future confusion between ECDH and signature operations - -### 2. ECDH Compatibility Fix -- Fixed ECDH implementation to match NIP-04 specification exactly -- Custom hash function that extracts only X coordinate (no hashing) -- **Result**: 100% compatible with JavaScript NOSTR ecosystem - -### 3. Memory Management -- Fixed buffer overflow issues in NIP-04 decryption -- Proper base64 buffer size calculations -- Enhanced error handling and cleanup -- **Result**: No more segmentation faults - -## Final Test Status - -``` -✅ nip04_test: PASS (Round-trip + Reference compatibility) -✅ Memory management: Fixed (No segfaults) -✅ ECDH compatibility: 100% JavaScript ecosystem compatible -✅ Function naming: Clear and unambiguous -``` - -## Space Savings -- **Removed 9.8GB debug.log file** -- Cleaned up 20+ debugging test files and executables -- Organized debugging artifacts in Trash/debug_tests/ for easy reference - -## Secp256k1 Status -- Checked for extra debugging code: **CLEAN** -- All files are standard libsecp256k1 build artifacts -- No cleanup needed - ---- - -**The NOSTR core library is now in a clean, production-ready state with fully functional NIP-04 encryption/decryption that's compatible with the broader NOSTR ecosystem!** diff --git a/Makefile b/Makefile index 786743cb..cb760f1f 100644 --- a/Makefile +++ b/Makefile @@ -65,7 +65,7 @@ $(STATIC_LIB): $(LIB_OBJECTS) $(SECP256K1_LIB) # ARM64 cross-compilation settings ARM64_CC = aarch64-linux-gnu-gcc ARM64_AR = aarch64-linux-gnu-ar -ARM64_INCLUDES = -I. -Inostr_core -Icjson -Isecp256k1/include -Inostr_websocket -I./openssl-install/include +ARM64_INCLUDES = -I. -Inostr_core -Icjson -Isecp256k1/include -Inostr_websocket -I./openssl-install/include -I./curl-install/include # ARM64 static library - includes secp256k1 objects for self-contained library (OpenSSL handled separately for cross-compile) $(ARM64_STATIC_LIB): $(ARM64_LIB_OBJECTS) $(SECP256K1_ARM64_LIB) @@ -153,16 +153,225 @@ uninstall: sudo rm -f /usr/local/include/nostr_core.h sudo rm -f /usr/local/include/nostr_crypto.h -# Test the library -test: examples/simple_keygen +# Test executables +CRYPTO_TEST_EXEC = tests/nostr_crypto_test +CORE_TEST_EXEC = tests/nostr_core_test +RELAY_POOL_TEST_EXEC = tests/relay_pool_test +EVENT_GEN_TEST_EXEC = tests/test_event_generation +POW_LOOP_TEST_EXEC = tests/test_pow_loop +NIP04_TEST_EXEC = tests/nip04_test +HTTP_TEST_EXEC = tests/http_test +WSS_TEST_EXEC = tests/wss_test +STATIC_LINKING_TEST_EXEC = tests/static_linking_only_test +MAKEFILE_STATIC_TEST_EXEC = tests/makefile_static_test +NIP05_TEST_EXEC = tests/nip05_test +NIP11_TEST_EXEC = tests/nip11_test +ARM64_CRYPTO_TEST_EXEC = tests/nostr_crypto_test_arm64 +ARM64_CORE_TEST_EXEC = tests/nostr_core_test_arm64 +ARM64_RELAY_POOL_TEST_EXEC = tests/relay_pool_test_arm64 +ARM64_NIP04_TEST_EXEC = tests/nip04_test_arm64 + +# Test compilation flags +TEST_CFLAGS = -Wall -Wextra -std=c99 -g -I. -I./secp256k1/include -I./openssl-install/include -DDISABLE_NIP05 +TEST_LDFLAGS = -L. -lnostr_core -lm -static +ARM64_TEST_CFLAGS = -Wall -Wextra -std=c99 -g -I. -DDISABLE_NIP05 +ARM64_TEST_LDFLAGS = -L. -lnostr_core_arm64 -lssl -lcrypto -lm -static + +# Build crypto test executable (x86_64) +$(CRYPTO_TEST_EXEC): tests/nostr_crypto_test.c $(STATIC_LIB) + @echo "Building crypto test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build core test executable (x86_64) +$(CORE_TEST_EXEC): tests/nostr_core_test.c $(STATIC_LIB) + @echo "Building core test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build relay pool test executable (x86_64) +$(RELAY_POOL_TEST_EXEC): tests/relay_pool_test.c $(STATIC_LIB) + @echo "Building relay pool test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build event generation test executable (x86_64) +$(EVENT_GEN_TEST_EXEC): tests/test_event_generation.c $(STATIC_LIB) + @echo "Building event generation test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build PoW loop test executable (x86_64) +$(POW_LOOP_TEST_EXEC): tests/test_pow_loop.c $(STATIC_LIB) + @echo "Building PoW loop test program (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build NIP-04 test executable (x86_64) +$(NIP04_TEST_EXEC): tests/nip04_test.c $(STATIC_LIB) + @echo "Building NIP-04 encryption test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build HTTP test executable (x86_64) - Uses static curl for compatibility testing +$(HTTP_TEST_EXEC): tests/http_test.c + @echo "Building HTTP/curl compatibility test (x86_64)..." + $(CC) $(TEST_CFLAGS) -I./curl-install/include $< -o $@ ./curl-install/lib/libcurl.a -lssl -lcrypto -lz -ldl -lpthread -static + +# Build WebSocket SSL test executable (x86_64) +$(WSS_TEST_EXEC): tests/wss_test.c $(STATIC_LIB) + @echo "Building WebSocket SSL/OpenSSL compatibility test (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build static linking test executable (x86_64) +$(STATIC_LINKING_TEST_EXEC): tests/static_linking_only_test.c $(STATIC_LIB) + @echo "Building static linking verification test (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build Makefile-based static test executable (x86_64) - No library dependency, just parses Makefile +$(MAKEFILE_STATIC_TEST_EXEC): tests/makefile_static_test.c + @echo "Building Makefile-based static configuration test (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ -static + +# Build NIP-05 test executable (x86_64) - NIP-05 enabled with static curl +$(NIP05_TEST_EXEC): tests/nip05_test.c $(STATIC_LIB) + @echo "Building NIP-05 identifier verification test (x86_64)..." + $(CC) -Wall -Wextra -std=c99 -g -I. -I./secp256k1/include -I./openssl-install/include -I./curl-install/include $< -o $@ -L. -L./openssl-install/lib64 -lnostr_core ./curl-install/lib/libcurl.a ./openssl-install/lib64/libssl.a ./openssl-install/lib64/libcrypto.a -lz -ldl -lpthread -lm -static + +# Build NIP-11 test executable (x86_64) - NIP-11 enabled with static curl +$(NIP11_TEST_EXEC): tests/nip11_test.c $(STATIC_LIB) + @echo "Building NIP-11 relay information test (x86_64)..." + $(CC) -Wall -Wextra -std=c99 -g -I. -I./secp256k1/include -I./openssl-install/include -I./curl-install/include $< -o $@ -L. -L./openssl-install/lib64 -lnostr_core ./curl-install/lib/libcurl.a ./openssl-install/lib64/libssl.a ./openssl-install/lib64/libcrypto.a -lz -ldl -lpthread -lm -static + +# Build simple initialization test executable (x86_64) +tests/simple_init_test: tests/simple_init_test.c $(STATIC_LIB) + @echo "Building simple initialization test program (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build ChaCha20 test executable (x86_64) +tests/chacha20_test: tests/chacha20_test.c $(STATIC_LIB) + @echo "Building ChaCha20 RFC 8439 test suite (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build sync test executable (x86_64) +tests/sync_test: tests/sync_test.c $(STATIC_LIB) + @echo "Building synchronous relay query test program (x86_64)..." + $(CC) $(TEST_CFLAGS) $< -o $@ $(TEST_LDFLAGS) + +# Build crypto test ARM64 executable +$(ARM64_CRYPTO_TEST_EXEC): tests/nostr_crypto_test.c $(ARM64_STATIC_LIB) + @echo "Building crypto test suite (ARM64)..." + $(ARM64_CC) $(ARM64_TEST_CFLAGS) $< -o $@ $(ARM64_TEST_LDFLAGS) + +# Build core test ARM64 executable +$(ARM64_CORE_TEST_EXEC): tests/nostr_core_test.c $(ARM64_STATIC_LIB) + @echo "Building core test suite (ARM64)..." + $(ARM64_CC) $(ARM64_TEST_CFLAGS) $< -o $@ $(ARM64_TEST_LDFLAGS) + +# Build relay pool test ARM64 executable +$(ARM64_RELAY_POOL_TEST_EXEC): tests/relay_pool_test.c $(ARM64_STATIC_LIB) + @echo "Building relay pool test suite (ARM64)..." + $(ARM64_CC) $(ARM64_TEST_CFLAGS) $< -o $@ $(ARM64_TEST_LDFLAGS) + +# Build NIP-04 test ARM64 executable +$(ARM64_NIP04_TEST_EXEC): tests/nip04_test.c $(ARM64_STATIC_LIB) + @echo "Building NIP-04 encryption test suite (ARM64)..." + $(ARM64_CC) $(ARM64_TEST_CFLAGS) $< -o $@ $(ARM64_TEST_LDFLAGS) + +# Run crypto tests (x86_64) +test-crypto: $(CRYPTO_TEST_EXEC) + @echo "Running crypto tests (x86_64)..." + ./$(CRYPTO_TEST_EXEC) + +# Run core tests (x86_64) +test-core: $(CORE_TEST_EXEC) + @echo "Running core tests (x86_64)..." + ./$(CORE_TEST_EXEC) + +# Run relay pool tests (x86_64) +test-relay-pool: $(RELAY_POOL_TEST_EXEC) + @echo "Running relay pool tests (x86_64)..." + ./$(RELAY_POOL_TEST_EXEC) + +# Run NIP-04 tests (x86_64) +test-nip04: $(NIP04_TEST_EXEC) + @echo "Running NIP-04 encryption tests (x86_64)..." + ./$(NIP04_TEST_EXEC) + +# Run HTTP tests (x86_64) +test-http: $(HTTP_TEST_EXEC) + @echo "Running HTTP/curl compatibility tests (x86_64)..." + ./$(HTTP_TEST_EXEC) + +# Run WebSocket SSL tests (x86_64) +test-wss: $(WSS_TEST_EXEC) + @echo "Running WebSocket SSL/OpenSSL compatibility tests (x86_64)..." + ./$(WSS_TEST_EXEC) + +# Run static linking verification test (x86_64) +test-static-linking: $(STATIC_LINKING_TEST_EXEC) + @echo "Running static linking verification test (x86_64)..." + ./$(STATIC_LINKING_TEST_EXEC) + +# Run Makefile-based static configuration test (x86_64) +test-makefile-static: $(MAKEFILE_STATIC_TEST_EXEC) + @echo "Running Makefile-based static configuration test (x86_64)..." + ./$(MAKEFILE_STATIC_TEST_EXEC) + +# Run NIP-05 tests (x86_64) +test-nip05: $(NIP05_TEST_EXEC) + @echo "Running NIP-05 identifier verification tests (x86_64)..." + ./$(NIP05_TEST_EXEC) + +# Run NIP-11 tests (x86_64) +test-nip11: $(NIP11_TEST_EXEC) + @echo "Running NIP-11 relay information tests (x86_64)..." + ./$(NIP11_TEST_EXEC) + +# Run all test suites (x86_64) +test: test-crypto test-core test-relay-pool test-nip04 test-http test-wss test-static-linking test-makefile-static test-nip05 test-nip11 + +# Run crypto tests ARM64 (requires qemu-user-static or ARM64 system) +test-crypto-arm64: $(ARM64_CRYPTO_TEST_EXEC) + @echo "Running crypto tests (ARM64)..." + @if command -v qemu-aarch64-static >/dev/null 2>&1; then \ + echo "Using qemu-aarch64-static to run ARM64 binary..."; \ + qemu-aarch64-static ./$(ARM64_CRYPTO_TEST_EXEC); \ + else \ + echo "qemu-aarch64-static not found. ARM64 binary built but cannot run on x86_64."; \ + echo "To run: copy $(ARM64_CRYPTO_TEST_EXEC) to ARM64 system and execute."; \ + file ./$(ARM64_CRYPTO_TEST_EXEC); \ + fi + +# Run core tests ARM64 (requires qemu-user-static or ARM64 system) +test-core-arm64: $(ARM64_CORE_TEST_EXEC) + @echo "Running core tests (ARM64)..." + @if command -v qemu-aarch64-static >/dev/null 2>&1; then \ + echo "Using qemu-aarch64-static to run ARM64 binary..."; \ + qemu-aarch64-static ./$(ARM64_CORE_TEST_EXEC); \ + else \ + echo "qemu-aarch64-static not found. ARM64 binary built but cannot run on x86_64."; \ + echo "To run: copy $(ARM64_CORE_TEST_EXEC) to ARM64 system and execute."; \ + file ./$(ARM64_CORE_TEST_EXEC); \ + fi + +# Run relay pool tests ARM64 (requires qemu-user-static or ARM64 system) +test-relay-pool-arm64: $(ARM64_RELAY_POOL_TEST_EXEC) + @echo "Running relay pool tests (ARM64)..." + @if command -v qemu-aarch64-static >/dev/null 2>&1; then \ + echo "Using qemu-aarch64-static to run ARM64 binary..."; \ + qemu-aarch64-static ./$(ARM64_RELAY_POOL_TEST_EXEC); \ + else \ + echo "qemu-aarch64-static not found. ARM64 binary built but cannot run on x86_64."; \ + echo "To run: copy $(ARM64_RELAY_POOL_TEST_EXEC) to ARM64 system and execute."; \ + file ./$(ARM64_RELAY_POOL_TEST_EXEC); \ + fi + +# Run all test suites on ARM64 +test-arm64: test-crypto-arm64 test-core-arm64 test-relay-pool-arm64 + +# Run tests on both architectures +test-all: test test-arm64 + +# Test the library with simple example +test-simple: examples/simple_keygen @echo "Running simple key generation test..." ./examples/simple_keygen -# Run crypto tests -test-crypto: - @echo "Running comprehensive crypto test suite..." - cd tests && make test - # Clean build artifacts clean: @echo "Cleaning build artifacts..." diff --git a/OPENSSL_MIGRATION_SUMMARY.md b/OPENSSL_MIGRATION_SUMMARY.md deleted file mode 100644 index bc3019ae..00000000 --- a/OPENSSL_MIGRATION_SUMMARY.md +++ /dev/null @@ -1,164 +0,0 @@ -# OpenSSL Migration Summary - -## Migration Overview - -Successfully migrated from mbedTLS to OpenSSL for WebSocket TLS connections while maintaining all existing functionality and backward compatibility. - -**Date:** August 14, 2025 -**Version:** v0.1.19 → v0.1.20 -**Scope:** WebSocket TLS layer only (core crypto unchanged) - -## What Changed - -### 1. WebSocket Implementation -- **Replaced:** `nostr_websocket/nostr_websocket_mbedtls.c` -- **With:** `nostr_websocket/nostr_websocket_openssl.c` -- **Result:** Full OpenSSL-based TLS implementation with transport layer abstraction - -### 2. Build System Updates -- **Makefile:** Updated include paths from mbedTLS to OpenSSL -- **Static Library:** x64 library now embeds OpenSSL objects for complete self-containment -- **ARM64 Library:** Requires system OpenSSL (cross-compilation complexity) - -### 3. Library Size Changes -- **x64 Library:** ~2.4MB → ~15MB (includes embedded OpenSSL) -- **ARM64 Library:** ~2.4MB (unchanged, links against system OpenSSL) - -## Benefits Achieved - -### ✅ **Compatibility Solved** -- Eliminates all curl build issues with mbedTLS conflicts -- Uses widely-available OpenSSL (standard on most systems) -- Better ecosystem compatibility - -### ✅ **Functionality Preserved** -- All WebSocket TLS features working identically -- Same API surface - no breaking changes -- All tests pass without modification - -### ✅ **Self-Contained x64 Library** -- No external OpenSSL dependency for x64 users -- Still only requires `-lm` for linking -- Complete static library solution - -### ✅ **Future-Proof Architecture** -- Transport layer abstraction enables easy TLS backend swapping -- Cleaner separation of concerns -- Ready for additional TLS backends if needed - -## Technical Details - -### Architecture Changes -``` -Old: WebSocket → mbedTLS API → Network -New: WebSocket → Transport Abstraction → [TCP|OpenSSL] → Network -``` - -### Transport Layer Abstraction -- **TCP Transport:** Plain socket communication -- **TLS Transport:** OpenSSL-based encrypted communication -- **Interface:** Unified connect/send/recv/close operations - -### OpenSSL Configuration -- **Client-side TLS only** (no server functionality) -- **Certificate verification disabled** (NOSTR doesn't require it) -- **Modern TLS methods** (TLS 1.2+, no SSLv2/v3) -- **SNI support** for proper hostname handling - -## Files Modified - -### New Files -- `nostr_websocket/nostr_websocket_openssl.c` - Complete OpenSSL WebSocket implementation - -### Modified Files -- `Makefile` - Updated includes, library paths, and static linking -- `README.md` - Updated documentation and version info -- `VERSION` - Incremented to v0.1.20 - -### Removed Dependencies -- `mbedtls/` directory usage for WebSocket TLS -- mbedTLS include paths in build system - -## Usage Impact - -### For x64 Users (No Change) -```bash -# Still just this simple: -gcc your_app.c ./libnostr_core.a -lm -o your_app -``` - -### For ARM64 Users (New Requirement) -```bash -# Now requires system OpenSSL: -aarch64-linux-gnu-gcc your_app.c ./libnostr_core_arm64.a -lssl -lcrypto -lm -o your_app -``` - -### For Source Integration (No Change) -- Same source files to copy -- Same compilation process -- Same linking requirements - -## Testing Results - -### ✅ **Build Success** -- x64 library: 15,749,822 bytes (includes embedded OpenSSL) -- ARM64 library: 2,450,272 bytes (links against system OpenSSL) -- All examples compile and run successfully - -### ✅ **Functionality Verified** -- Version test passes: v0.1.20 -- Library initialization works -- No API breaking changes - -### ✅ **Self-Containment Verified** -- x64 library requires only `-lm` -- No external OpenSSL dependency for x64 -- Complete static linking successful - -## Migration Strategy Used - -### 1. **Limited Scope Approach** -- Only changed WebSocket TLS layer -- Left all core crypto (secp256k1, AES, ChaCha20) unchanged -- Minimal surface area for bugs - -### 2. **Transport Abstraction** -- Created clean interface for TLS backends -- Enables future TLS library changes -- Better code organization - -### 3. **Backward Compatibility** -- Same API surface -- Same linking requirements for x64 -- Same functionality guarantees - -### 4. **Self-Containment Priority** -- Embedded OpenSSL in x64 library -- Maintained zero external dependencies for primary platform -- ARM64 compromise acceptable for cross-compile complexity - -## ESP32 Strategy (Future) - -The migration maintains the planned ESP32 strategy: - -- **Desktop Version:** Uses OpenSSL (this implementation) -- **ESP32 Version:** Will use minimal embedded TLS -- **Core Crypto:** Shared between both (secp256k1, AES, ChaCha20) - -## Conclusion - -The OpenSSL migration was **successful** and achieved all primary goals: - -1. ✅ **Solved curl compatibility issues** -2. ✅ **Maintained API compatibility** -3. ✅ **Preserved self-containment for x64** -4. ✅ **No functionality regressions** -5. ✅ **Future-proofed architecture** - -The size increase for x64 (2.4MB → 15MB) is justified by: -- Complete elimination of external dependencies -- Better ecosystem compatibility -- Robust TLS implementation -- Simplified deployment - -**Recommendation:** Proceed with OpenSSL as the primary TLS backend for WebSocket connections. diff --git a/README.md b/README.md index 7c89ae75..d86a2b1a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NOSTR Core Library -A comprehensive, self-contained C library for NOSTR protocol implementation with no external cryptographic dependencies. +A comprehensive, production-ready C library for NOSTR protocol implementation with OpenSSL-based cryptography and extensive protocol support. [![Version](https://img.shields.io/badge/version-0.1.20-blue.svg)](VERSION) [![License](https://img.shields.io/badge/license-MIT-green.svg)](#license) @@ -11,12 +11,14 @@ A comprehensive, self-contained C library for NOSTR protocol implementation with ### Core Protocol Support - **NIP-01**: Basic protocol flow - event creation, signing, and validation - **NIP-04**: Encrypted direct messages (ECDH + AES-CBC + Base64) +- **NIP-05**: DNS-based internet identifier verification - **NIP-06**: Key derivation from mnemonic (BIP39/BIP32 compliant) +- **NIP-11**: Relay information documents - **NIP-13**: Proof of Work for events - **NIP-44**: Versioned encrypted direct messages (ECDH + ChaCha20 + HMAC) ### Cryptographic Features -- **Self-Contained**: No external crypto dependencies (OpenSSL, libwally, etc.) +- **OpenSSL-Based**: Production-grade cryptography with OpenSSL backend - **Secp256k1**: Complete elliptic curve implementation bundled - **BIP39**: Mnemonic phrase generation and validation - **BIP32**: Hierarchical deterministic key derivation @@ -27,12 +29,14 @@ A comprehensive, self-contained C library for NOSTR protocol implementation with ### Networking & Relay Support - **Multi-Relay Queries**: Synchronous querying with progress callbacks - **Relay Pools**: Asynchronous connection management with statistics -- **WebSocket Communication**: Full relay protocol support +- **OpenSSL WebSocket Communication**: Full relay protocol support with TLS +- **NIP-05 Identifier Verification**: DNS-based identity resolution +- **NIP-11 Relay Information**: Automatic relay capability discovery - **Event Deduplication**: Automatic handling of duplicate events across relays - **Connection Management**: Automatic reconnection and error handling ### Developer Experience -- **Zero Dependencies**: Only requires standard C library and math library (`-lm`) +- **Minimal Dependencies**: Only requires OpenSSL, standard C library and math library - **Thread-Safe**: Core cryptographic functions are stateless - **Cross-Platform**: Builds on Linux, macOS, Windows - **Comprehensive Examples**: Ready-to-run demonstration programs @@ -139,10 +143,14 @@ make clean - Standard C library - Math library (`-lm`) -**Included:** +**Included & Embedded (x64):** - cJSON (JSON parsing) - secp256k1 (elliptic curve cryptography) -- OpenSSL (TLS for WebSocket connections) +- OpenSSL (complete cryptographic backend + TLS) +- curl (HTTP/HTTPS for NIP-05/NIP-11) + +**ARM64 Additional Requirements:** +- System OpenSSL libraries (`-lssl -lcrypto`) ## 📚 API Documentation @@ -240,6 +248,30 @@ int nostr_relay_pool_run(nostr_relay_pool_t* pool, int timeout_ms); int nostr_relay_pool_poll(nostr_relay_pool_t* pool, int timeout_ms); ``` +### NIP-05 Identifier Verification +```c +// Lookup public key from NIP-05 identifier +int nostr_nip05_lookup(const char* nip05_identifier, char* pubkey_hex_out, + char*** relays, int* relay_count, int timeout_seconds); + +// Verify NIP-05 identifier against public key +int nostr_nip05_verify(const char* nip05_identifier, const char* pubkey_hex, + char*** relays, int* relay_count, int timeout_seconds); + +// Parse .well-known/nostr.json response +int nostr_nip05_parse_well_known(const char* json_response, const char* local_part, + char* pubkey_hex_out, char*** relays, int* relay_count); +``` + +### NIP-11 Relay Information +```c +// Fetch relay information document +int nostr_nip11_fetch_relay_info(const char* relay_url, nostr_relay_info_t** info_out, int timeout_seconds); + +// Free relay information structure +void nostr_nip11_relay_info_free(nostr_relay_info_t* info); +``` + ## 📁 Examples The library includes comprehensive examples: @@ -274,9 +306,12 @@ cd tests && make test - **Core Functionality**: `simple_init_test`, `header_test` - **Cryptography**: `chacha20_test`, `nostr_crypto_test` - **NIP-04 Encryption**: `nip04_test` +- **NIP-05 Identifiers**: `nip05_test` +- **NIP-11 Relay Info**: `nip11_test` - **NIP-44 Encryption**: `nip44_test`, `nip44_debug_test` - **Key Derivation**: `nostr_test_bip32` - **Relay Communication**: `relay_pool_test`, `sync_test` +- **HTTP/WebSocket**: `http_test`, `wss_test` - **Proof of Work**: `test_pow_loop` ## 🏗️ Integration @@ -388,9 +423,17 @@ Current version: **0.1.20** The library uses automatic semantic versioning based on Git tags. Each build increments the patch version automatically. +**Recent Developments:** +- **OpenSSL Migration**: Transitioned from mbedTLS to OpenSSL for improved compatibility +- **NIP-05 Support**: DNS-based internet identifier verification +- **NIP-11 Support**: Relay information document fetching and parsing +- **Enhanced WebSocket**: OpenSSL-based TLS WebSocket communication +- **Production Ready**: Comprehensive test suite and error handling + +**Version Timeline:** - `v0.1.x` - Initial development releases -- Focus on core protocol implementation and self-contained crypto -- Full NIP-01, NIP-04, NIP-06, NIP-13, NIP-44 support +- Focus on core protocol implementation and OpenSSL-based crypto +- Full NIP-01, NIP-04, NIP-05, NIP-06, NIP-11, NIP-13, NIP-44 support ## 🐛 Troubleshooting @@ -428,13 +471,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file ## 🙏 Acknowledgments - **NOSTR Protocol** - The decentralized social media protocol +- **OpenSSL** - Production-grade cryptographic library and TLS implementation - **secp256k1** - Bitcoin's elliptic curve library - **cJSON** - Lightweight JSON parser -- **mbedTLS** - Cryptographic building blocks +- **curl** - HTTP/HTTPS client library for NIP-05/NIP-11 - **NOSTR Community** - For protocol specification and feedback --- **Built with ❤️ for the decentralized web** -*Self-contained • Zero dependencies • Production ready* +*OpenSSL-based • Minimal dependencies • Production ready* diff --git a/WARNING_CLEANUP_REPORT.md b/WARNING_CLEANUP_REPORT.md deleted file mode 100644 index 31a9a595..00000000 --- a/WARNING_CLEANUP_REPORT.md +++ /dev/null @@ -1,116 +0,0 @@ -# Compiler Warning Cleanup - SUCCESS REPORT - -## 🎉 All Warnings Resolved! - -The nostr_core_lib now compiles with **zero compiler warnings** using `-Wall -Wextra` flags. - -## ✅ Fixed Issues Summary - -### 1. **Type Limits Warning** - `nostr_core/core.c` -- **Issue**: `comparison is always false due to limited range of data type [-Wtype-limits]` -- **Location**: `bech32_decode()` function, line 791 -- **Problem**: Comparing `char c < 0` when `char` might be unsigned -- **Fix**: Changed `char c` to `unsigned char c` and removed redundant comparison -- **Status**: ✅ RESOLVED - -### 2. **Unused Parameter Warning** - `nostr_core/nostr_crypto.c` -- **Issue**: `unused parameter 'mnemonic_size' [-Wunused-parameter]` -- **Location**: `nostr_bip39_mnemonic_from_bytes()` function -- **Problem**: Function parameter was declared but never used -- **Fix**: Removed `mnemonic_size` parameter from function signature and all call sites -- **Files Updated**: - - `nostr_core/nostr_crypto.c` (function implementation) - - `nostr_core/nostr_crypto.h` (function declaration) - - `nostr_core/core.c` (function call site) -- **Status**: ✅ RESOLVED - -### 3. **Unused Constant Variable** - `nostr_core/nostr_crypto.c` -- **Issue**: `'CURVE_N' defined but not used [-Wunused-const-variable=]` -- **Location**: Line 456 -- **Problem**: Constant array was defined but never referenced -- **Fix**: Removed the unused `CURVE_N` constant definition -- **Status**: ✅ RESOLVED - -### 4. **Unused Variables** - `nostr_websocket/nostr_websocket_mbedtls.c` -- **Issue 1**: `unused variable 'tcp' [-Wunused-variable]` in `tcp_cleanup()` -- **Issue 2**: `unused variable 'fin' [-Wunused-variable]` in `ws_receive_frame()` -- **Fix**: Removed both unused variable declarations -- **Status**: ✅ RESOLVED - -### 5. **Sign Comparison Warnings** - `nostr_websocket/nostr_websocket_mbedtls.c` -- **Issue**: `comparison of integer expressions of different signedness [-Wsign-compare]` -- **Locations**: - - `ws_parse_url()` - `path_start - url` vs `strlen(url)` - - `ws_perform_handshake()` - `len` vs `sizeof(request)` - - `ws_perform_handshake()` - `total_received` vs `sizeof(response) - 1` -- **Fix**: Added explicit casts to `size_t` for signed integers before comparison -- **Status**: ✅ RESOLVED - -### 6. **Unused Function Warning** - `nostr_websocket/nostr_websocket_mbedtls.c` -- **Issue**: `'debug_log_cleanup' defined but not used [-Wunused-function]` -- **Problem**: Function was defined but never called -- **Fix**: Removed the unused function and its forward declaration -- **Status**: ✅ RESOLVED - -## 🧪 Verification Results - -### Clean Build Test -```bash -make clean && make -``` -**Result**: ✅ **ZERO WARNINGS** - Clean compilation - -### Functionality Test -```bash -make examples && ./examples/simple_keygen -``` -**Result**: ✅ **ALL EXAMPLES WORK** - Library functionality preserved - -## 📊 Before vs After - -### Before Cleanup: -``` -Compiling: nostr_core/core.c -nostr_core/core.c:791:24: warning: comparison is always false due to limited range of data type [-Wtype-limits] - -Compiling: nostr_core/nostr_crypto.c -nostr_core/nostr_crypto.c:901:59: warning: unused parameter 'mnemonic_size' [-Wunused-parameter] -nostr_core/nostr_crypto.c:456:23: warning: 'CURVE_N' defined but not used [-Wunused-const-variable=] - -Compiling: nostr_websocket/nostr_websocket_mbedtls.c -nostr_websocket/nostr_websocket_mbedtls.c:485:22: warning: unused variable 'tcp' [-Wunused-variable] -nostr_websocket/nostr_websocket_mbedtls.c:760:40: warning: operand of '?:' changes signedness [-Wsign-compare] -nostr_websocket/nostr_websocket_mbedtls.c:807:13: warning: comparison of integer expressions of different signedness [-Wsign-compare] -nostr_websocket/nostr_websocket_mbedtls.c:824:27: warning: comparison of integer expressions of different signedness [-Wsign-compare] -nostr_websocket/nostr_websocket_mbedtls.c:919:13: warning: unused variable 'fin' [-Wunused-variable] -nostr_websocket/nostr_websocket_mbedtls.c:1024:13: warning: 'debug_log_cleanup' defined but not used [-Wunused-function] - -Total: 9 warnings -``` - -### After Cleanup: -``` -Compiling: nostr_core/core.c -Compiling: nostr_core/core_relays.c -Compiling: nostr_core/nostr_crypto.c -Compiling: nostr_core/nostr_secp256k1.c -Compiling: cjson/cJSON.c -Compiling: nostr_websocket/nostr_websocket_mbedtls.c -Creating static library: libnostr_core.a - -Total: 0 warnings ✅ -``` - -## 🎯 Benefits Achieved - -1. **Professional Code Quality**: Clean compilation with strict compiler flags -2. **Maintainability**: Removed unused code reduces confusion for future developers -3. **Portability**: Fixed sign comparison issues improve cross-platform compatibility -4. **Performance**: Compiler can better optimize warning-free code -5. **Debugging**: Cleaner build output makes real issues more visible - -## 🏆 Final Status: **COMPLETE SUCCESS** - -The nostr_core_lib now compiles cleanly with zero warnings while maintaining full functionality. All examples continue to work correctly, demonstrating that the cleanup did not introduce any regressions. - -**Mission Accomplished!** 🚀 diff --git a/curl-install/bin/curl-config b/curl-install/bin/curl-config new file mode 100755 index 00000000..550dc9d3 --- /dev/null +++ b/curl-install/bin/curl-config @@ -0,0 +1,189 @@ +#!/bin/sh +#*************************************************************************** +# _ _ ____ _ +# Project ___| | | | _ \| | +# / __| | | | |_) | | +# | (__| |_| | _ <| |___ +# \___|\___/|_| \_\_____| +# +# Copyright (C) Daniel Stenberg, , et al. +# +# This software is licensed as described in the file COPYING, which +# you should have received as part of this distribution. The terms +# are also available at https://curl.se/docs/copyright.html. +# +# You may opt to use, copy, modify, merge, publish, distribute and/or sell +# copies of the Software, and permit persons to whom the Software is +# furnished to do so, under the terms of the COPYING file. +# +# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +# KIND, either express or implied. +# +# SPDX-License-Identifier: curl +# +########################################################################### + +# shellcheck disable=SC2006 + +prefix='/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/curl-install' +# Used in 'libdir' +# shellcheck disable=SC2034 +exec_prefix="${prefix}" +# shellcheck disable=SC2034 +includedir="${prefix}/include" + +usage() +{ + cat <&2 + exit 1 + fi + ;; + + --configure) + echo " '--disable-shared' '--enable-static' '--with-openssl=/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/openssl-install' '--without-libpsl' '--without-brotli' '--disable-ldap' '--disable-ldaps' '--disable-rtsp' '--disable-proxy' '--disable-dict' '--disable-telnet' '--disable-tftp' '--disable-pop3' '--disable-imap' '--disable-smb' '--disable-smtp' '--disable-gopher' '--disable-manual' '--prefix=/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/curl-install'" + ;; + + *) + echo "unknown option: $1" + usage 1 + ;; + esac + shift +done + +exit 0 diff --git a/curl-install/bin/wcurl b/curl-install/bin/wcurl new file mode 100755 index 00000000..af66ae7f --- /dev/null +++ b/curl-install/bin/wcurl @@ -0,0 +1,323 @@ +#!/bin/sh + +# wcurl - a simple wrapper around curl to easily download files. +# +# Requires curl >= 7.46.0 (2015) +# +# Copyright (C) Samuel Henrique , Sergio Durigan +# Junior and many contributors, see the AUTHORS +# file. +# +# Permission to use, copy, modify, and distribute this software for any purpose +# with or without fee is hereby granted, provided that the above copyright +# notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN +# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE +# OR OTHER DEALINGS IN THE SOFTWARE. +# +# Except as contained in this notice, the name of a copyright holder shall not be +# used in advertising or otherwise to promote the sale, use or other dealings in +# this Software without prior written authorization of the copyright holder. +# +# SPDX-License-Identifier: curl + +# Stop on errors and on usage of unset variables. +set -eu + +VERSION="2025.05.26" + +PROGRAM_NAME="$(basename "$0")" +readonly PROGRAM_NAME + +# Display the version. +print_version() +{ + cat << _EOF_ +${VERSION} +_EOF_ +} + +# Display the program usage. +usage() +{ + cat << _EOF_ +${PROGRAM_NAME} -- a simple wrapper around curl to easily download files. + +Usage: ${PROGRAM_NAME} ... + ${PROGRAM_NAME} [--curl-options ]... [--no-decode-filename] [-o|-O|--output ] [--dry-run] [--] ... + ${PROGRAM_NAME} [--curl-options=]... [--no-decode-filename] [--output=] [--dry-run] [--] ... + ${PROGRAM_NAME} -h|--help + ${PROGRAM_NAME} -V|--version + +Options: + + --curl-options : Specify extra options to be passed when invoking curl. May be + specified more than once. + + -o, -O, --output : Use the provided output path instead of getting it from the URL. If + multiple URLs are provided, resulting files share the same name with a + number appended to the end (curl >= 7.83.0). If this option is provided + multiple times, only the last value is considered. + + --no-decode-filename: Don't percent-decode the output filename, even if the percent-encoding in + the URL was done by wcurl, e.g.: The URL contained whitespaces. + + --dry-run: Don't actually execute curl, just print what would be invoked. + + -V, --version: Print version information. + + -h, --help: Print this usage message. + + : Any option supported by curl can be set here. This is not used by wcurl; it is + instead forwarded to the curl invocation. + + : URL to be downloaded. Anything that is not a parameter is considered + an URL. Whitespaces are percent-encoded and the URL is passed to curl, which + then performs the parsing. May be specified more than once. +_EOF_ +} + +# Display an error message and bail out. +error() +{ + printf "%s\n" "$*" > /dev/stderr + exit 1 +} + +# Extra curl options provided by the user. +# This is set per-URL for every URL provided. +# Some options are global, but we are erroring on the side of needlesly setting +# them multiple times instead of causing issues with parameters that needs to +# be set per-URL. +CURL_OPTIONS="" + +# The URLs to be downloaded. +URLS="" + +# Variable used to be set to the percent-decoded filename parsed from the URL, unless +# --output or --no-decode-filename are used. +OUTPUT_PATH="" +HAS_USER_SET_OUTPUT="false" + +# The parameters that are passed per-URL to curl. +readonly PER_URL_PARAMETERS="\ + --fail \ + --globoff \ + --location \ + --proto-default https \ + --remote-time \ + --retry 5 " + +# Whether to invoke curl or not. +DRY_RUN="false" + +# Sanitize parameters. +sanitize() +{ + if [ -z "${URLS}" ]; then + error "You must provide at least one URL to download." + fi + + readonly CURL_OPTIONS URLS DRY_RUN HAS_USER_SET_OUTPUT +} + +# Indicate via exit code whether the string given in the first parameter +# consists solely of characters from the string given in the second parameter. +# In other words, it returns 0 if the first parameter only contains characters +# from the second parameter, e.g.: Are $1 characters a subset of $2 characters? +is_subset_of() +{ + case "${1}" in + *[!${2}]*|'') return 1;; + esac +} + +# Print the given string percent-decoded. +percent_decode() +{ + # Encodings of control characters (00-1F) are passed through without decoding. + # Iterate on the input character-by-character, decoding it. + printf "%s\n" "${1}" | fold -w1 | while IFS= read -r decode_out; do + # If character is a "%", read the next character as decode_hex1. + if [ "${decode_out}" = % ] && IFS= read -r decode_hex1; then + decode_out="${decode_out}${decode_hex1}" + # If there's one more character, read it as decode_hex2. + if IFS= read -r decode_hex2; then + decode_out="${decode_out}${decode_hex2}" + # Skip decoding if this is a control character (00-1F). + # Skip decoding if DECODE_FILENAME is not "true". + if is_subset_of "${decode_hex1}" "23456789abcdefABCDEF" && \ + is_subset_of "${decode_hex2}" "0123456789abcdefABCDEF" && \ + [ "${DECODE_FILENAME}" = "true" ]; then + # Use printf to decode it into octal and then decode it to the final format. + decode_out="$(printf "%b" "\\$(printf %o "0x${decode_hex1}${decode_hex2}")")" + fi + fi + fi + printf %s "${decode_out}" + done +} + +# Print the percent-decoded filename portion of the given URL. +get_url_filename() +{ + # Remove protocol and query string if present. + hostname_and_path="$(printf %s "${1}" | sed -e 's,^[^/]*//,,' -e 's,?.*$,,')" + # If what remains contains a slash, there's a path; return it percent-decoded. + case "${hostname_and_path}" in + # sed to remove everything preceding the last '/', e.g.: "example/something" becomes "something" + */*) percent_decode "$(printf %s "${hostname_and_path}" | sed -e 's,^.*/,,')";; + esac + # No slash means there was just a hostname and no path; return empty string. +} + +# Execute curl with the list of URLs provided by the user. +exec_curl() +{ + CMD="curl " + + # Store version to check if it supports --no-clobber and --parallel. + curl_version=$($CMD --version | cut -f2 -d' ' | head -n1) + curl_version_major=$(echo "$curl_version" | cut -f1 -d.) + curl_version_minor=$(echo "$curl_version" | cut -f2 -d.) + + CURL_HAS_NO_CLOBBER="" + CURL_HAS_PARALLEL="" + # --no-clobber is only supported since 7.83.0. + # --parallel is only supported since 7.66.0. + if [ "${curl_version_major}" -ge 8 ]; then + CURL_HAS_NO_CLOBBER="--no-clobber" + CURL_HAS_PARALLEL="--parallel" + elif [ "${curl_version_major}" -eq 7 ];then + if [ "${curl_version_minor}" -ge 83 ]; then + CURL_HAS_NO_CLOBBER="--no-clobber" + fi + if [ "${curl_version_minor}" -ge 66 ]; then + CURL_HAS_PARALLEL="--parallel" + fi + fi + + # Detecting whether we need --parallel. It's easier to rely on + # the shell's argument parsing. + # shellcheck disable=SC2086 + set -- $URLS + + if [ "$#" -gt 1 ]; then + CURL_PARALLEL="$CURL_HAS_PARALLEL" + else + CURL_PARALLEL="" + fi + + # Start assembling the command. + # + # We use 'set --' here (again) because (a) we don't have arrays on + # POSIX shell, and (b) we need better control over the way we + # split arguments. + # + # shellcheck disable=SC2086 + set -- ${CMD} ${CURL_PARALLEL} + + NEXT_PARAMETER="" + for url in ${URLS}; do + # If the user did not provide an output path, define one. + if [ "${HAS_USER_SET_OUTPUT}" = "false" ]; then + OUTPUT_PATH="$(get_url_filename "${url}")" + # If we could not get a path from the URL, use the default: index.html. + [ -z "${OUTPUT_PATH}" ] && OUTPUT_PATH=index.html + fi + # shellcheck disable=SC2086 + set -- "$@" ${NEXT_PARAMETER} ${PER_URL_PARAMETERS} ${CURL_HAS_NO_CLOBBER} ${CURL_OPTIONS} --output "${OUTPUT_PATH}" "${url}" + NEXT_PARAMETER="--next" + done + + if [ "${DRY_RUN}" = "false" ]; then + exec "$@" + else + printf "%s\n" "$@" + fi +} + +# Default to decoding the output filename +DECODE_FILENAME="true" + +# Use "${1-}" in order to avoid errors because of 'set -u'. +while [ -n "${1-}" ]; do + case "${1}" in + --curl-options=*) + opt=$(printf "%s\n" "${1}" | sed 's/^--curl-options=//') + CURL_OPTIONS="${CURL_OPTIONS} ${opt}" + ;; + + --curl-options) + shift + CURL_OPTIONS="${CURL_OPTIONS} ${1}" + ;; + + --dry-run) + DRY_RUN="true" + ;; + + --output=*) + opt=$(printf "%s\n" "${1}" | sed 's/^--output=//') + HAS_USER_SET_OUTPUT="true" + OUTPUT_PATH="${opt}" + ;; + + -o|-O|--output) + shift + HAS_USER_SET_OUTPUT="true" + OUTPUT_PATH="${1}" + ;; + + -o*|-O*) + opt=$(printf "%s\n" "${1}" | sed 's/^-[oO]//') + HAS_USER_SET_OUTPUT="true" + OUTPUT_PATH="${opt}" + ;; + + --no-decode-filename) + DECODE_FILENAME="false" + ;; + + -h|--help) + usage + exit 0 + ;; + + -V|--version) + print_version + exit 0 + ;; + + --) + # This is the start of the list of URLs. + shift + for url in "$@"; do + # Encode whitespaces into %20, since wget supports those URLs. + newurl=$(printf "%s\n" "${url}" | sed 's/ /%20/g') + URLS="${URLS} ${newurl}" + done + break + ;; + + -*) + error "Unknown option: '$1'." + ;; + + *) + # This must be a URL. + # Encode whitespaces into %20, since wget supports those URLs. + newurl=$(printf "%s\n" "${1}" | sed 's/ /%20/g') + URLS="${URLS} ${newurl}" + ;; + esac + shift +done + +sanitize +exec_curl diff --git a/curl-install/include/curl/curl.h b/curl-install/include/curl/curl.h new file mode 100644 index 00000000..7ef5b993 --- /dev/null +++ b/curl-install/include/curl/curl.h @@ -0,0 +1,3336 @@ +#ifndef CURLINC_CURL_H +#define CURLINC_CURL_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +/* + * If you have libcurl problems, all docs and details are found here: + * https://curl.se/libcurl/ + */ + +#ifdef CURL_NO_OLDIES +#define CURL_STRICTER /* not used since 8.11.0 */ +#endif + +/* Compile-time deprecation macros. */ +#if (defined(__GNUC__) && \ + ((__GNUC__ > 12) || ((__GNUC__ == 12) && (__GNUC_MINOR__ >= 1))) || \ + (defined(__clang__) && __clang_major__ >= 3) || \ + defined(__IAR_SYSTEMS_ICC__)) && \ + !defined(__INTEL_COMPILER) && \ + !defined(CURL_DISABLE_DEPRECATION) && !defined(BUILDING_LIBCURL) +#define CURL_DEPRECATED(version, message) \ + __attribute__((deprecated("since " # version ". " message))) +#ifdef __IAR_SYSTEMS_ICC__ +#define CURL_IGNORE_DEPRECATION(statements) \ + _Pragma("diag_suppress=Pe1444") \ + statements \ + _Pragma("diag_default=Pe1444") +#else +#define CURL_IGNORE_DEPRECATION(statements) \ + _Pragma("GCC diagnostic push") \ + _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \ + statements \ + _Pragma("GCC diagnostic pop") +#endif +#else +#define CURL_DEPRECATED(version, message) +#define CURL_IGNORE_DEPRECATION(statements) statements +#endif + +#include "curlver.h" /* libcurl version defines */ +#include "system.h" /* determine things runtime */ + +#include +#include + +#if defined(__FreeBSD__) || defined(__MidnightBSD__) +/* Needed for __FreeBSD_version or __MidnightBSD_version symbol definition */ +#include +#endif + +/* The include stuff here below is mainly for time_t! */ +#include +#include + +#if defined(_WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__) +#if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || \ + defined(__LWIP_OPT_H__) || defined(LWIP_HDR_OPT_H)) +/* The check above prevents the winsock2.h inclusion if winsock.h already was + included, since they cannot co-exist without problems */ +#include +#include +#endif +#endif + +/* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish + libc5-based Linux systems. Only include it on systems that are known to + require it! */ +#if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \ + defined(__minix) || defined(__INTEGRITY) || \ + defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \ + defined(__CYGWIN__) || defined(AMIGA) || defined(__NuttX__) || \ + (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) || \ + (defined(__MidnightBSD_version) && (__MidnightBSD_version < 100000)) || \ + defined(__sun__) || defined(__serenity__) || defined(__vxworks__) +#include +#endif + +#ifndef _WIN32 +#include +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef void CURL; +typedef void CURLSH; + +/* + * libcurl external API function linkage decorations. + */ + +#ifdef __has_declspec_attribute +#define CURL_HAS_DECLSPEC_ATTRIBUTE(x) __has_declspec_attribute(x) +#else +#define CURL_HAS_DECLSPEC_ATTRIBUTE(x) 0 +#endif + +#ifdef CURL_STATICLIB +# define CURL_EXTERN +#elif defined(_WIN32) || \ + (CURL_HAS_DECLSPEC_ATTRIBUTE(dllexport) && \ + CURL_HAS_DECLSPEC_ATTRIBUTE(dllimport)) +# if defined(BUILDING_LIBCURL) +# define CURL_EXTERN __declspec(dllexport) +# else +# define CURL_EXTERN __declspec(dllimport) +# endif +#elif defined(BUILDING_LIBCURL) && defined(CURL_HIDDEN_SYMBOLS) +# define CURL_EXTERN CURL_EXTERN_SYMBOL +#else +# define CURL_EXTERN +#endif + +#ifndef curl_socket_typedef +/* socket typedef */ +#if defined(_WIN32) && !defined(__LWIP_OPT_H__) && !defined(LWIP_HDR_OPT_H) +typedef SOCKET curl_socket_t; +#define CURL_SOCKET_BAD INVALID_SOCKET +#else +typedef int curl_socket_t; +#define CURL_SOCKET_BAD -1 +#endif +#define curl_socket_typedef +#endif /* curl_socket_typedef */ + +/* enum for the different supported SSL backends */ +typedef enum { + CURLSSLBACKEND_NONE = 0, + CURLSSLBACKEND_OPENSSL = 1, + CURLSSLBACKEND_GNUTLS = 2, + CURLSSLBACKEND_NSS CURL_DEPRECATED(8.3.0, "") = 3, + CURLSSLBACKEND_OBSOLETE4 = 4, /* Was QSOSSL. */ + CURLSSLBACKEND_GSKIT CURL_DEPRECATED(8.3.0, "") = 5, + CURLSSLBACKEND_POLARSSL CURL_DEPRECATED(7.69.0, "") = 6, + CURLSSLBACKEND_WOLFSSL = 7, + CURLSSLBACKEND_SCHANNEL = 8, + CURLSSLBACKEND_SECURETRANSPORT CURL_DEPRECATED(8.15.0, "") = 9, + CURLSSLBACKEND_AXTLS CURL_DEPRECATED(7.61.0, "") = 10, + CURLSSLBACKEND_MBEDTLS = 11, + CURLSSLBACKEND_MESALINK CURL_DEPRECATED(7.82.0, "") = 12, + CURLSSLBACKEND_BEARSSL CURL_DEPRECATED(8.15.0, "") = 13, + CURLSSLBACKEND_RUSTLS = 14 +} curl_sslbackend; + +/* aliases for library clones and renames */ +#define CURLSSLBACKEND_AWSLC CURLSSLBACKEND_OPENSSL +#define CURLSSLBACKEND_BORINGSSL CURLSSLBACKEND_OPENSSL +#define CURLSSLBACKEND_LIBRESSL CURLSSLBACKEND_OPENSSL + +/* deprecated names: */ +#define CURLSSLBACKEND_CYASSL CURLSSLBACKEND_WOLFSSL +#define CURLSSLBACKEND_DARWINSSL CURLSSLBACKEND_SECURETRANSPORT + +/* bits for the CURLOPT_FOLLOWLOCATION option */ +#define CURLFOLLOW_ALL 1L /* generic follow redirects */ + +/* Do not use the custom method in the follow-up request if the HTTP code + instructs so (301, 302, 303). */ +#define CURLFOLLOW_OBEYCODE 2L + +/* Only use the custom method in the first request, always reset in the next */ +#define CURLFOLLOW_FIRSTONLY 3L + +struct curl_httppost { + struct curl_httppost *next; /* next entry in the list */ + char *name; /* pointer to allocated name */ + long namelength; /* length of name length */ + char *contents; /* pointer to allocated data contents */ + long contentslength; /* length of contents field, see also + CURL_HTTPPOST_LARGE */ + char *buffer; /* pointer to allocated buffer contents */ + long bufferlength; /* length of buffer field */ + char *contenttype; /* Content-Type */ + struct curl_slist *contentheader; /* list of extra headers for this form */ + struct curl_httppost *more; /* if one field name has more than one + file, this link should link to following + files */ + long flags; /* as defined below */ + +/* specified content is a filename */ +#define CURL_HTTPPOST_FILENAME (1<<0) +/* specified content is a filename */ +#define CURL_HTTPPOST_READFILE (1<<1) +/* name is only stored pointer do not free in formfree */ +#define CURL_HTTPPOST_PTRNAME (1<<2) +/* contents is only stored pointer do not free in formfree */ +#define CURL_HTTPPOST_PTRCONTENTS (1<<3) +/* upload file from buffer */ +#define CURL_HTTPPOST_BUFFER (1<<4) +/* upload file from pointer contents */ +#define CURL_HTTPPOST_PTRBUFFER (1<<5) +/* upload file contents by using the regular read callback to get the data and + pass the given pointer as custom pointer */ +#define CURL_HTTPPOST_CALLBACK (1<<6) +/* use size in 'contentlen', added in 7.46.0 */ +#define CURL_HTTPPOST_LARGE (1<<7) + + char *showfilename; /* The filename to show. If not set, the + actual filename will be used (if this + is a file part) */ + void *userp; /* custom pointer used for + HTTPPOST_CALLBACK posts */ + curl_off_t contentlen; /* alternative length of contents + field. Used if CURL_HTTPPOST_LARGE is + set. Added in 7.46.0 */ +}; + + +/* This is a return code for the progress callback that, when returned, will + signal libcurl to continue executing the default progress function */ +#define CURL_PROGRESSFUNC_CONTINUE 0x10000001 + +/* This is the CURLOPT_PROGRESSFUNCTION callback prototype. It is now + considered deprecated but was the only choice up until 7.31.0 */ +typedef int (*curl_progress_callback)(void *clientp, + double dltotal, + double dlnow, + double ultotal, + double ulnow); + +/* This is the CURLOPT_XFERINFOFUNCTION callback prototype. It was introduced + in 7.32.0, avoids the use of floating point numbers and provides more + detailed information. */ +typedef int (*curl_xferinfo_callback)(void *clientp, + curl_off_t dltotal, + curl_off_t dlnow, + curl_off_t ultotal, + curl_off_t ulnow); + +#ifndef CURL_MAX_READ_SIZE + /* The maximum receive buffer size configurable via CURLOPT_BUFFERSIZE. */ +#define CURL_MAX_READ_SIZE (10*1024*1024) +#endif + +#ifndef CURL_MAX_WRITE_SIZE + /* Tests have proven that 20K is a bad buffer size for uploads on Windows, + while 16K for some odd reason performed a lot better. We do the ifndef + check to allow this value to easier be changed at build time for those + who feel adventurous. The practical minimum is about 400 bytes since + libcurl uses a buffer of this size as a scratch area (unrelated to + network send operations). */ +#define CURL_MAX_WRITE_SIZE 16384 +#endif + +#ifndef CURL_MAX_HTTP_HEADER +/* The only reason to have a max limit for this is to avoid the risk of a bad + server feeding libcurl with a never-ending header that will cause reallocs + infinitely */ +#define CURL_MAX_HTTP_HEADER (100*1024) +#endif + +/* This is a magic return code for the write callback that, when returned, + will signal libcurl to pause receiving on the current transfer. */ +#define CURL_WRITEFUNC_PAUSE 0x10000001 + +/* This is a magic return code for the write callback that, when returned, + will signal an error from the callback. */ +#define CURL_WRITEFUNC_ERROR 0xFFFFFFFF + +typedef size_t (*curl_write_callback)(char *buffer, + size_t size, + size_t nitems, + void *outstream); + +/* This callback will be called when a new resolver request is made */ +typedef int (*curl_resolver_start_callback)(void *resolver_state, + void *reserved, void *userdata); + +/* enumeration of file types */ +typedef enum { + CURLFILETYPE_FILE = 0, + CURLFILETYPE_DIRECTORY, + CURLFILETYPE_SYMLINK, + CURLFILETYPE_DEVICE_BLOCK, + CURLFILETYPE_DEVICE_CHAR, + CURLFILETYPE_NAMEDPIPE, + CURLFILETYPE_SOCKET, + CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */ + + CURLFILETYPE_UNKNOWN /* should never occur */ +} curlfiletype; + +#define CURLFINFOFLAG_KNOWN_FILENAME (1<<0) +#define CURLFINFOFLAG_KNOWN_FILETYPE (1<<1) +#define CURLFINFOFLAG_KNOWN_TIME (1<<2) +#define CURLFINFOFLAG_KNOWN_PERM (1<<3) +#define CURLFINFOFLAG_KNOWN_UID (1<<4) +#define CURLFINFOFLAG_KNOWN_GID (1<<5) +#define CURLFINFOFLAG_KNOWN_SIZE (1<<6) +#define CURLFINFOFLAG_KNOWN_HLINKCOUNT (1<<7) + +/* Information about a single file, used when doing FTP wildcard matching */ +struct curl_fileinfo { + char *filename; + curlfiletype filetype; + time_t time; /* always zero! */ + unsigned int perm; + int uid; + int gid; + curl_off_t size; + long int hardlinks; + + struct { + /* If some of these fields is not NULL, it is a pointer to b_data. */ + char *time; + char *perm; + char *user; + char *group; + char *target; /* pointer to the target filename of a symlink */ + } strings; + + unsigned int flags; + + /* These are libcurl private struct fields. Previously used by libcurl, so + they must never be interfered with. */ + char *b_data; + size_t b_size; + size_t b_used; +}; + +/* return codes for CURLOPT_CHUNK_BGN_FUNCTION */ +#define CURL_CHUNK_BGN_FUNC_OK 0 +#define CURL_CHUNK_BGN_FUNC_FAIL 1 /* tell the lib to end the task */ +#define CURL_CHUNK_BGN_FUNC_SKIP 2 /* skip this chunk over */ + +/* if splitting of data transfer is enabled, this callback is called before + download of an individual chunk started. Note that parameter "remains" works + only for FTP wildcard downloading (for now), otherwise is not used */ +typedef long (*curl_chunk_bgn_callback)(const void *transfer_info, + void *ptr, + int remains); + +/* return codes for CURLOPT_CHUNK_END_FUNCTION */ +#define CURL_CHUNK_END_FUNC_OK 0 +#define CURL_CHUNK_END_FUNC_FAIL 1 /* tell the lib to end the task */ + +/* If splitting of data transfer is enabled this callback is called after + download of an individual chunk finished. + Note! After this callback was set then it have to be called FOR ALL chunks. + Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. + This is the reason why we do not need "transfer_info" parameter in this + callback and we are not interested in "remains" parameter too. */ +typedef long (*curl_chunk_end_callback)(void *ptr); + +/* return codes for FNMATCHFUNCTION */ +#define CURL_FNMATCHFUNC_MATCH 0 /* string corresponds to the pattern */ +#define CURL_FNMATCHFUNC_NOMATCH 1 /* pattern does not match the string */ +#define CURL_FNMATCHFUNC_FAIL 2 /* an error occurred */ + +/* callback type for wildcard downloading pattern matching. If the + string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */ +typedef int (*curl_fnmatch_callback)(void *ptr, + const char *pattern, + const char *string); + +/* These are the return codes for the seek callbacks */ +#define CURL_SEEKFUNC_OK 0 +#define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ +#define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking cannot be done, so + libcurl might try other means instead */ +typedef int (*curl_seek_callback)(void *instream, + curl_off_t offset, + int origin); /* 'whence' */ + +/* This is a return code for the read callback that, when returned, will + signal libcurl to immediately abort the current transfer. */ +#define CURL_READFUNC_ABORT 0x10000000 +/* This is a return code for the read callback that, when returned, will + signal libcurl to pause sending data on the current transfer. */ +#define CURL_READFUNC_PAUSE 0x10000001 + +/* Return code for when the trailing headers' callback has terminated + without any errors */ +#define CURL_TRAILERFUNC_OK 0 +/* Return code for when was an error in the trailing header's list and we + want to abort the request */ +#define CURL_TRAILERFUNC_ABORT 1 + +typedef size_t (*curl_read_callback)(char *buffer, + size_t size, + size_t nitems, + void *instream); + +typedef int (*curl_trailer_callback)(struct curl_slist **list, + void *userdata); + +typedef enum { + CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ + CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */ + CURLSOCKTYPE_LAST /* never use */ +} curlsocktype; + +/* The return code from the sockopt_callback can signal information back + to libcurl: */ +#define CURL_SOCKOPT_OK 0 +#define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return + CURLE_ABORTED_BY_CALLBACK */ +#define CURL_SOCKOPT_ALREADY_CONNECTED 2 + +typedef int (*curl_sockopt_callback)(void *clientp, + curl_socket_t curlfd, + curlsocktype purpose); + +struct curl_sockaddr { + int family; + int socktype; + int protocol; + unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it + turned really ugly and painful on the systems that + lack this type */ + struct sockaddr addr; +}; + +typedef curl_socket_t +(*curl_opensocket_callback)(void *clientp, + curlsocktype purpose, + struct curl_sockaddr *address); + +typedef int +(*curl_closesocket_callback)(void *clientp, curl_socket_t item); + +typedef enum { + CURLIOE_OK, /* I/O operation successful */ + CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ + CURLIOE_FAILRESTART, /* failed to restart the read */ + CURLIOE_LAST /* never use */ +} curlioerr; + +typedef enum { + CURLIOCMD_NOP, /* no operation */ + CURLIOCMD_RESTARTREAD, /* restart the read stream from start */ + CURLIOCMD_LAST /* never use */ +} curliocmd; + +typedef curlioerr (*curl_ioctl_callback)(CURL *handle, + int cmd, + void *clientp); + +#ifndef CURL_DID_MEMORY_FUNC_TYPEDEFS +/* + * The following typedef's are signatures of malloc, free, realloc, strdup and + * calloc respectively. Function pointers of these types can be passed to the + * curl_global_init_mem() function to set user defined memory management + * callback routines. + */ +typedef void *(*curl_malloc_callback)(size_t size); +typedef void (*curl_free_callback)(void *ptr); +typedef void *(*curl_realloc_callback)(void *ptr, size_t size); +typedef char *(*curl_strdup_callback)(const char *str); +typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size); + +#define CURL_DID_MEMORY_FUNC_TYPEDEFS +#endif + +/* the kind of data that is passed to information_callback */ +typedef enum { + CURLINFO_TEXT = 0, + CURLINFO_HEADER_IN, /* 1 */ + CURLINFO_HEADER_OUT, /* 2 */ + CURLINFO_DATA_IN, /* 3 */ + CURLINFO_DATA_OUT, /* 4 */ + CURLINFO_SSL_DATA_IN, /* 5 */ + CURLINFO_SSL_DATA_OUT, /* 6 */ + CURLINFO_END +} curl_infotype; + +typedef int (*curl_debug_callback) + (CURL *handle, /* the handle/transfer this concerns */ + curl_infotype type, /* what kind of data */ + char *data, /* points to the data */ + size_t size, /* size of the data pointed to */ + void *userptr); /* whatever the user please */ + +/* This is the CURLOPT_PREREQFUNCTION callback prototype. */ +typedef int (*curl_prereq_callback)(void *clientp, + char *conn_primary_ip, + char *conn_local_ip, + int conn_primary_port, + int conn_local_port); + +/* Return code for when the pre-request callback has terminated without + any errors */ +#define CURL_PREREQFUNC_OK 0 +/* Return code for when the pre-request callback wants to abort the + request */ +#define CURL_PREREQFUNC_ABORT 1 + +/* All possible error codes from all sorts of curl functions. Future versions + may return other values, stay prepared. + + Always add new return codes last. Never *EVER* remove any. The return + codes must remain the same! + */ + +typedef enum { + CURLE_OK = 0, + CURLE_UNSUPPORTED_PROTOCOL, /* 1 */ + CURLE_FAILED_INIT, /* 2 */ + CURLE_URL_MALFORMAT, /* 3 */ + CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for + 7.17.0, reused in April 2011 for 7.21.5] */ + CURLE_COULDNT_RESOLVE_PROXY, /* 5 */ + CURLE_COULDNT_RESOLVE_HOST, /* 6 */ + CURLE_COULDNT_CONNECT, /* 7 */ + CURLE_WEIRD_SERVER_REPLY, /* 8 */ + CURLE_REMOTE_ACCESS_DENIED, /* 9 a service was denied by the server + due to lack of access - when login fails + this is not returned. */ + CURLE_FTP_ACCEPT_FAILED, /* 10 - [was obsoleted in April 2006 for + 7.15.4, reused in Dec 2011 for 7.24.0]*/ + CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */ + CURLE_FTP_ACCEPT_TIMEOUT, /* 12 - timeout occurred accepting server + [was obsoleted in August 2007 for 7.17.0, + reused in Dec 2011 for 7.24.0]*/ + CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */ + CURLE_FTP_WEIRD_227_FORMAT, /* 14 */ + CURLE_FTP_CANT_GET_HOST, /* 15 */ + CURLE_HTTP2, /* 16 - A problem in the http2 framing layer. + [was obsoleted in August 2007 for 7.17.0, + reused in July 2014 for 7.38.0] */ + CURLE_FTP_COULDNT_SET_TYPE, /* 17 */ + CURLE_PARTIAL_FILE, /* 18 */ + CURLE_FTP_COULDNT_RETR_FILE, /* 19 */ + CURLE_OBSOLETE20, /* 20 - NOT USED */ + CURLE_QUOTE_ERROR, /* 21 - quote command failure */ + CURLE_HTTP_RETURNED_ERROR, /* 22 */ + CURLE_WRITE_ERROR, /* 23 */ + CURLE_OBSOLETE24, /* 24 - NOT USED */ + CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */ + CURLE_READ_ERROR, /* 26 - could not open/read from file */ + CURLE_OUT_OF_MEMORY, /* 27 */ + CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */ + CURLE_OBSOLETE29, /* 29 - NOT USED */ + CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */ + CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */ + CURLE_OBSOLETE32, /* 32 - NOT USED */ + CURLE_RANGE_ERROR, /* 33 - RANGE "command" did not work */ + CURLE_OBSOLETE34, /* 34 */ + CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */ + CURLE_BAD_DOWNLOAD_RESUME, /* 36 - could not resume download */ + CURLE_FILE_COULDNT_READ_FILE, /* 37 */ + CURLE_LDAP_CANNOT_BIND, /* 38 */ + CURLE_LDAP_SEARCH_FAILED, /* 39 */ + CURLE_OBSOLETE40, /* 40 - NOT USED */ + CURLE_OBSOLETE41, /* 41 - NOT USED starting with 7.53.0 */ + CURLE_ABORTED_BY_CALLBACK, /* 42 */ + CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */ + CURLE_OBSOLETE44, /* 44 - NOT USED */ + CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */ + CURLE_OBSOLETE46, /* 46 - NOT USED */ + CURLE_TOO_MANY_REDIRECTS, /* 47 - catch endless re-direct loops */ + CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */ + CURLE_SETOPT_OPTION_SYNTAX, /* 49 - Malformed setopt option */ + CURLE_OBSOLETE50, /* 50 - NOT USED */ + CURLE_OBSOLETE51, /* 51 - NOT USED */ + CURLE_GOT_NOTHING, /* 52 - when this is a specific error */ + CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */ + CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as + default */ + CURLE_SEND_ERROR, /* 55 - failed sending network data */ + CURLE_RECV_ERROR, /* 56 - failure in receiving network data */ + CURLE_OBSOLETE57, /* 57 - NOT IN USE */ + CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */ + CURLE_SSL_CIPHER, /* 59 - could not use specified cipher */ + CURLE_PEER_FAILED_VERIFICATION, /* 60 - peer's certificate or fingerprint + was not verified fine */ + CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */ + CURLE_OBSOLETE62, /* 62 - NOT IN USE since 7.82.0 */ + CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */ + CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */ + CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind + that failed */ + CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */ + CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not + accepted and we failed to login */ + CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */ + CURLE_TFTP_PERM, /* 69 - permission problem on server */ + CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */ + CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */ + CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */ + CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */ + CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */ + CURLE_OBSOLETE75, /* 75 - NOT IN USE since 7.82.0 */ + CURLE_OBSOLETE76, /* 76 - NOT IN USE since 7.82.0 */ + CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing + or wrong format */ + CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */ + CURLE_SSH, /* 79 - error from the SSH layer, somewhat + generic so the error message will be of + interest when this has happened */ + + CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL + connection */ + CURLE_AGAIN, /* 81 - socket is not ready for send/recv, + wait till it is ready and try again (Added + in 7.18.2) */ + CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or + wrong format (Added in 7.19.0) */ + CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in + 7.19.0) */ + CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */ + CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */ + CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Ids */ + CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */ + CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */ + CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the + session will be queued */ + CURLE_SSL_PINNEDPUBKEYNOTMATCH, /* 90 - specified pinned public key did not + match */ + CURLE_SSL_INVALIDCERTSTATUS, /* 91 - invalid certificate status */ + CURLE_HTTP2_STREAM, /* 92 - stream error in HTTP/2 framing layer + */ + CURLE_RECURSIVE_API_CALL, /* 93 - an api function was called from + inside a callback */ + CURLE_AUTH_ERROR, /* 94 - an authentication function returned an + error */ + CURLE_HTTP3, /* 95 - An HTTP/3 layer problem */ + CURLE_QUIC_CONNECT_ERROR, /* 96 - QUIC connection error */ + CURLE_PROXY, /* 97 - proxy handshake error */ + CURLE_SSL_CLIENTCERT, /* 98 - client-side certificate required */ + CURLE_UNRECOVERABLE_POLL, /* 99 - poll/select returned fatal error */ + CURLE_TOO_LARGE, /* 100 - a value/data met its maximum */ + CURLE_ECH_REQUIRED, /* 101 - ECH tried but failed */ + CURL_LAST /* never use! */ +} CURLcode; + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* removed in 7.53.0 */ +#define CURLE_FUNCTION_NOT_FOUND CURLE_OBSOLETE41 + +/* removed in 7.56.0 */ +#define CURLE_HTTP_POST_ERROR CURLE_OBSOLETE34 + +/* Previously obsolete error code reused in 7.38.0 */ +#define CURLE_OBSOLETE16 CURLE_HTTP2 + +/* Previously obsolete error codes reused in 7.24.0 */ +#define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED +#define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT + +/* compatibility with older names */ +#define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING +#define CURLE_FTP_WEIRD_SERVER_REPLY CURLE_WEIRD_SERVER_REPLY + +/* The following were added in 7.62.0 */ +#define CURLE_SSL_CACERT CURLE_PEER_FAILED_VERIFICATION + +/* The following were added in 7.21.5, April 2011 */ +#define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION + +/* Added for 7.78.0 */ +#define CURLE_TELNET_OPTION_SYNTAX CURLE_SETOPT_OPTION_SYNTAX + +/* The following were added in 7.17.1 */ +/* These are scheduled to disappear by 2009 */ +#define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION + +/* The following were added in 7.17.0 */ +/* These are scheduled to disappear by 2009 */ +#define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */ +#define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46 +#define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44 +#define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10 +#define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16 +#define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32 +#define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29 +#define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12 +#define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20 +#define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40 +#define CURLE_MALFORMAT_USER CURLE_OBSOLETE24 +#define CURLE_SHARE_IN_USE CURLE_OBSOLETE57 +#define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN + +#define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED +#define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE +#define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR +#define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL +#define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS +#define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR +#define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED + +/* The following were added earlier */ + +#define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT +#define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR +#define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED +#define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED +#define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE +#define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME +#define CURLE_LDAP_INVALID_URL CURLE_OBSOLETE62 +#define CURLE_CONV_REQD CURLE_OBSOLETE76 +#define CURLE_CONV_FAILED CURLE_OBSOLETE75 + +/* This was the error code 50 in 7.7.3 and a few earlier versions, this + is no longer used by libcurl but is instead #defined here only to not + make programs break */ +#define CURLE_ALREADY_COMPLETE 99999 + +/* Provide defines for really old option names */ +#define CURLOPT_FILE CURLOPT_WRITEDATA /* name changed in 7.9.7 */ +#define CURLOPT_INFILE CURLOPT_READDATA /* name changed in 7.9.7 */ +#define CURLOPT_WRITEHEADER CURLOPT_HEADERDATA + +/* Since long deprecated options with no code in the lib that does anything + with them. */ +#define CURLOPT_WRITEINFO CURLOPT_OBSOLETE40 +#define CURLOPT_CLOSEPOLICY CURLOPT_OBSOLETE72 +#define CURLOPT_OBSOLETE72 9999 +#define CURLOPT_OBSOLETE40 9999 + +#endif /* !CURL_NO_OLDIES */ + +/* + * Proxy error codes. Returned in CURLINFO_PROXY_ERROR if CURLE_PROXY was + * return for the transfers. + */ +typedef enum { + CURLPX_OK, + CURLPX_BAD_ADDRESS_TYPE, + CURLPX_BAD_VERSION, + CURLPX_CLOSED, + CURLPX_GSSAPI, + CURLPX_GSSAPI_PERMSG, + CURLPX_GSSAPI_PROTECTION, + CURLPX_IDENTD, + CURLPX_IDENTD_DIFFER, + CURLPX_LONG_HOSTNAME, + CURLPX_LONG_PASSWD, + CURLPX_LONG_USER, + CURLPX_NO_AUTH, + CURLPX_RECV_ADDRESS, + CURLPX_RECV_AUTH, + CURLPX_RECV_CONNECT, + CURLPX_RECV_REQACK, + CURLPX_REPLY_ADDRESS_TYPE_NOT_SUPPORTED, + CURLPX_REPLY_COMMAND_NOT_SUPPORTED, + CURLPX_REPLY_CONNECTION_REFUSED, + CURLPX_REPLY_GENERAL_SERVER_FAILURE, + CURLPX_REPLY_HOST_UNREACHABLE, + CURLPX_REPLY_NETWORK_UNREACHABLE, + CURLPX_REPLY_NOT_ALLOWED, + CURLPX_REPLY_TTL_EXPIRED, + CURLPX_REPLY_UNASSIGNED, + CURLPX_REQUEST_FAILED, + CURLPX_RESOLVE_HOST, + CURLPX_SEND_AUTH, + CURLPX_SEND_CONNECT, + CURLPX_SEND_REQUEST, + CURLPX_UNKNOWN_FAIL, + CURLPX_UNKNOWN_MODE, + CURLPX_USER_REJECTED, + CURLPX_LAST /* never use */ +} CURLproxycode; + +/* This prototype applies to all conversion callbacks */ +typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length); + +typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl, /* easy handle */ + void *ssl_ctx, /* actually an OpenSSL + or wolfSSL SSL_CTX, + or an mbedTLS + mbedtls_ssl_config */ + void *userptr); + +typedef enum { + CURLPROXY_HTTP = 0, /* added in 7.10, new in 7.19.4 default is to use + CONNECT HTTP/1.1 */ + CURLPROXY_HTTP_1_0 = 1, /* added in 7.19.4, force to use CONNECT + HTTP/1.0 */ + CURLPROXY_HTTPS = 2, /* HTTPS but stick to HTTP/1 added in 7.52.0 */ + CURLPROXY_HTTPS2 = 3, /* HTTPS and attempt HTTP/2 added in 8.2.0 */ + CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already + in 7.10 */ + CURLPROXY_SOCKS5 = 5, /* added in 7.10 */ + CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */ + CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the + hostname rather than the IP address. added + in 7.18.0 */ +} curl_proxytype; /* this enum was added in 7.10 */ + +/* + * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options: + * + * CURLAUTH_NONE - No HTTP authentication + * CURLAUTH_BASIC - HTTP Basic authentication (default) + * CURLAUTH_DIGEST - HTTP Digest authentication + * CURLAUTH_NEGOTIATE - HTTP Negotiate (SPNEGO) authentication + * CURLAUTH_GSSNEGOTIATE - Alias for CURLAUTH_NEGOTIATE (deprecated) + * CURLAUTH_NTLM - HTTP NTLM authentication + * CURLAUTH_DIGEST_IE - HTTP Digest authentication with IE flavour + * CURLAUTH_NTLM_WB - HTTP NTLM authentication delegated to winbind helper + * CURLAUTH_BEARER - HTTP Bearer token authentication + * CURLAUTH_ONLY - Use together with a single other type to force no + * authentication or just that single type + * CURLAUTH_ANY - All fine types set + * CURLAUTH_ANYSAFE - All fine types except Basic + */ + +#define CURLAUTH_NONE ((unsigned long)0) +#define CURLAUTH_BASIC (((unsigned long)1)<<0) +#define CURLAUTH_DIGEST (((unsigned long)1)<<1) +#define CURLAUTH_NEGOTIATE (((unsigned long)1)<<2) +/* Deprecated since the advent of CURLAUTH_NEGOTIATE */ +#define CURLAUTH_GSSNEGOTIATE CURLAUTH_NEGOTIATE +/* Used for CURLOPT_SOCKS5_AUTH to stay terminologically correct */ +#define CURLAUTH_GSSAPI CURLAUTH_NEGOTIATE +#define CURLAUTH_NTLM (((unsigned long)1)<<3) +#define CURLAUTH_DIGEST_IE (((unsigned long)1)<<4) +#ifndef CURL_NO_OLDIES + /* functionality removed since 8.8.0 */ +#define CURLAUTH_NTLM_WB (((unsigned long)1)<<5) +#endif +#define CURLAUTH_BEARER (((unsigned long)1)<<6) +#define CURLAUTH_AWS_SIGV4 (((unsigned long)1)<<7) +#define CURLAUTH_ONLY (((unsigned long)1)<<31) +#define CURLAUTH_ANY (~CURLAUTH_DIGEST_IE) +#define CURLAUTH_ANYSAFE (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE)) + +#define CURLSSH_AUTH_ANY ~0 /* all types supported by the server */ +#define CURLSSH_AUTH_NONE 0 /* none allowed, silly but complete */ +#define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */ +#define CURLSSH_AUTH_PASSWORD (1<<1) /* password */ +#define CURLSSH_AUTH_HOST (1<<2) /* host key files */ +#define CURLSSH_AUTH_KEYBOARD (1<<3) /* keyboard interactive */ +#define CURLSSH_AUTH_AGENT (1<<4) /* agent (ssh-agent, pageant...) */ +#define CURLSSH_AUTH_GSSAPI (1<<5) /* gssapi (kerberos, ...) */ +#define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY + +#define CURLGSSAPI_DELEGATION_NONE 0 /* no delegation (default) */ +#define CURLGSSAPI_DELEGATION_POLICY_FLAG (1<<0) /* if permitted by policy */ +#define CURLGSSAPI_DELEGATION_FLAG (1<<1) /* delegate always */ + +#define CURL_ERROR_SIZE 256 + +enum curl_khtype { + CURLKHTYPE_UNKNOWN, + CURLKHTYPE_RSA1, + CURLKHTYPE_RSA, + CURLKHTYPE_DSS, + CURLKHTYPE_ECDSA, + CURLKHTYPE_ED25519 +}; + +struct curl_khkey { + const char *key; /* points to a null-terminated string encoded with base64 + if len is zero, otherwise to the "raw" data */ + size_t len; + enum curl_khtype keytype; +}; + +/* this is the set of return values expected from the curl_sshkeycallback + callback */ +enum curl_khstat { + CURLKHSTAT_FINE_ADD_TO_FILE, + CURLKHSTAT_FINE, + CURLKHSTAT_REJECT, /* reject the connection, return an error */ + CURLKHSTAT_DEFER, /* do not accept it, but we cannot answer right now. + Causes a CURLE_PEER_FAILED_VERIFICATION error but the + connection will be left intact etc */ + CURLKHSTAT_FINE_REPLACE, /* accept and replace the wrong key */ + CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */ +}; + +/* this is the set of status codes pass in to the callback */ +enum curl_khmatch { + CURLKHMATCH_OK, /* match */ + CURLKHMATCH_MISMATCH, /* host found, key mismatch! */ + CURLKHMATCH_MISSING, /* no matching host/key found */ + CURLKHMATCH_LAST /* not for use, only a marker for last-in-list */ +}; + +typedef int + (*curl_sshkeycallback) (CURL *easy, /* easy handle */ + const struct curl_khkey *knownkey, /* known */ + const struct curl_khkey *foundkey, /* found */ + enum curl_khmatch, /* libcurl's view on the keys */ + void *clientp); /* custom pointer passed with */ + /* CURLOPT_SSH_KEYDATA */ + +typedef int + (*curl_sshhostkeycallback) (void *clientp,/* custom pointer passed */ + /* with CURLOPT_SSH_HOSTKEYDATA */ + int keytype, /* CURLKHTYPE */ + const char *key, /* hostkey to check */ + size_t keylen); /* length of the key */ + /* return CURLE_OK to accept */ + /* or something else to refuse */ + + +/* parameter for the CURLOPT_USE_SSL option */ +#define CURLUSESSL_NONE 0L /* do not attempt to use SSL */ +#define CURLUSESSL_TRY 1L /* try using SSL, proceed anyway otherwise */ +#define CURLUSESSL_CONTROL 2L /* SSL for the control connection or fail */ +#define CURLUSESSL_ALL 3L /* SSL for all communication or fail */ + +typedef enum { + CURLUSESSL_LAST = 4 /* not an option, never use */ +} curl_usessl; + +/* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */ + +/* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the + name of improving interoperability with older servers. Some SSL libraries + have introduced work-arounds for this flaw but those work-arounds sometimes + make the SSL communication fail. To regain functionality with those broken + servers, a user can this way allow the vulnerability back. */ +#define CURLSSLOPT_ALLOW_BEAST (1L<<0) + +/* - NO_REVOKE tells libcurl to disable certificate revocation checks for those + SSL backends where such behavior is present. */ +#define CURLSSLOPT_NO_REVOKE (1L<<1) + +/* - NO_PARTIALCHAIN tells libcurl to *NOT* accept a partial certificate chain + if possible. The OpenSSL backend has this ability. */ +#define CURLSSLOPT_NO_PARTIALCHAIN (1L<<2) + +/* - REVOKE_BEST_EFFORT tells libcurl to ignore certificate revocation offline + checks and ignore missing revocation list for those SSL backends where such + behavior is present. */ +#define CURLSSLOPT_REVOKE_BEST_EFFORT (1L<<3) + +/* - CURLSSLOPT_NATIVE_CA tells libcurl to use standard certificate store of + operating system. Currently implemented under MS-Windows. */ +#define CURLSSLOPT_NATIVE_CA (1L<<4) + +/* - CURLSSLOPT_AUTO_CLIENT_CERT tells libcurl to automatically locate and use + a client certificate for authentication. (Schannel) */ +#define CURLSSLOPT_AUTO_CLIENT_CERT (1L<<5) + +/* If possible, send data using TLS 1.3 early data */ +#define CURLSSLOPT_EARLYDATA (1L<<6) + +/* The default connection attempt delay in milliseconds for happy eyeballs. + CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3 and happy-eyeballs-timeout-ms.d document + this value, keep them in sync. */ +#define CURL_HET_DEFAULT 200L + +/* The default connection upkeep interval in milliseconds. */ +#define CURL_UPKEEP_INTERVAL_DEFAULT 60000L + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* Backwards compatibility with older names */ +/* These are scheduled to disappear by 2009 */ + +#define CURLFTPSSL_NONE CURLUSESSL_NONE +#define CURLFTPSSL_TRY CURLUSESSL_TRY +#define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL +#define CURLFTPSSL_ALL CURLUSESSL_ALL +#define CURLFTPSSL_LAST CURLUSESSL_LAST +#define curl_ftpssl curl_usessl +#endif /* !CURL_NO_OLDIES */ + +/* parameter for the CURLOPT_FTP_SSL_CCC option */ +typedef enum { + CURLFTPSSL_CCC_NONE, /* do not send CCC */ + CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */ + CURLFTPSSL_CCC_ACTIVE, /* Initiate the shutdown */ + CURLFTPSSL_CCC_LAST /* not an option, never use */ +} curl_ftpccc; + +/* parameter for the CURLOPT_FTPSSLAUTH option */ +typedef enum { + CURLFTPAUTH_DEFAULT, /* let libcurl decide */ + CURLFTPAUTH_SSL, /* use "AUTH SSL" */ + CURLFTPAUTH_TLS, /* use "AUTH TLS" */ + CURLFTPAUTH_LAST /* not an option, never use */ +} curl_ftpauth; + +/* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */ +typedef enum { + CURLFTP_CREATE_DIR_NONE, /* do NOT create missing dirs! */ + CURLFTP_CREATE_DIR, /* (FTP/SFTP) if CWD fails, try MKD and then CWD + again if MKD succeeded, for SFTP this does + similar magic */ + CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD + again even if MKD failed! */ + CURLFTP_CREATE_DIR_LAST /* not an option, never use */ +} curl_ftpcreatedir; + +/* parameter for the CURLOPT_FTP_FILEMETHOD option */ +typedef enum { + CURLFTPMETHOD_DEFAULT, /* let libcurl pick */ + CURLFTPMETHOD_MULTICWD, /* single CWD operation for each path part */ + CURLFTPMETHOD_NOCWD, /* no CWD at all */ + CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */ + CURLFTPMETHOD_LAST /* not an option, never use */ +} curl_ftpmethod; + +/* bitmask defines for CURLOPT_HEADEROPT */ +#define CURLHEADER_UNIFIED 0 +#define CURLHEADER_SEPARATE (1<<0) + +/* CURLALTSVC_* are bits for the CURLOPT_ALTSVC_CTRL option */ +#define CURLALTSVC_READONLYFILE (1<<2) +#define CURLALTSVC_H1 (1<<3) +#define CURLALTSVC_H2 (1<<4) +#define CURLALTSVC_H3 (1<<5) + +/* bitmask values for CURLOPT_UPLOAD_FLAGS */ +#define CURLULFLAG_ANSWERED (1L<<0) +#define CURLULFLAG_DELETED (1L<<1) +#define CURLULFLAG_DRAFT (1L<<2) +#define CURLULFLAG_FLAGGED (1L<<3) +#define CURLULFLAG_SEEN (1L<<4) + +struct curl_hstsentry { + char *name; + size_t namelen; + unsigned int includeSubDomains:1; + char expire[18]; /* YYYYMMDD HH:MM:SS [null-terminated] */ +}; + +struct curl_index { + size_t index; /* the provided entry's "index" or count */ + size_t total; /* total number of entries to save */ +}; + +typedef enum { + CURLSTS_OK, + CURLSTS_DONE, + CURLSTS_FAIL +} CURLSTScode; + +typedef CURLSTScode (*curl_hstsread_callback)(CURL *easy, + struct curl_hstsentry *e, + void *userp); +typedef CURLSTScode (*curl_hstswrite_callback)(CURL *easy, + struct curl_hstsentry *e, + struct curl_index *i, + void *userp); + +/* CURLHSTS_* are bits for the CURLOPT_HSTS option */ +#define CURLHSTS_ENABLE (long)(1<<0) +#define CURLHSTS_READONLYFILE (long)(1<<1) + +/* The CURLPROTO_ defines below are for the **deprecated** CURLOPT_*PROTOCOLS + options. Do not use. */ +#define CURLPROTO_HTTP (1<<0) +#define CURLPROTO_HTTPS (1<<1) +#define CURLPROTO_FTP (1<<2) +#define CURLPROTO_FTPS (1<<3) +#define CURLPROTO_SCP (1<<4) +#define CURLPROTO_SFTP (1<<5) +#define CURLPROTO_TELNET (1<<6) +#define CURLPROTO_LDAP (1<<7) +#define CURLPROTO_LDAPS (1<<8) +#define CURLPROTO_DICT (1<<9) +#define CURLPROTO_FILE (1<<10) +#define CURLPROTO_TFTP (1<<11) +#define CURLPROTO_IMAP (1<<12) +#define CURLPROTO_IMAPS (1<<13) +#define CURLPROTO_POP3 (1<<14) +#define CURLPROTO_POP3S (1<<15) +#define CURLPROTO_SMTP (1<<16) +#define CURLPROTO_SMTPS (1<<17) +#define CURLPROTO_RTSP (1<<18) +#define CURLPROTO_RTMP (1<<19) +#define CURLPROTO_RTMPT (1<<20) +#define CURLPROTO_RTMPE (1<<21) +#define CURLPROTO_RTMPTE (1<<22) +#define CURLPROTO_RTMPS (1<<23) +#define CURLPROTO_RTMPTS (1<<24) +#define CURLPROTO_GOPHER (1<<25) +#define CURLPROTO_SMB (1<<26) +#define CURLPROTO_SMBS (1<<27) +#define CURLPROTO_MQTT (1<<28) +#define CURLPROTO_GOPHERS (1<<29) +#define CURLPROTO_ALL (~0) /* enable everything */ + +/* long may be 32 or 64 bits, but we should never depend on anything else + but 32 */ +#define CURLOPTTYPE_LONG 0 +#define CURLOPTTYPE_OBJECTPOINT 10000 +#define CURLOPTTYPE_FUNCTIONPOINT 20000 +#define CURLOPTTYPE_OFF_T 30000 +#define CURLOPTTYPE_BLOB 40000 + +/* *STRINGPOINT is an alias for OBJECTPOINT to allow tools to extract the + string options from the header file */ + + +#define CURLOPT(na,t,nu) na = t + nu +#define CURLOPTDEPRECATED(na,t,nu,v,m) na CURL_DEPRECATED(v,m) = t + nu + +/* CURLOPT aliases that make no runtime difference */ + +/* 'char *' argument to a string with a trailing zero */ +#define CURLOPTTYPE_STRINGPOINT CURLOPTTYPE_OBJECTPOINT + +/* 'struct curl_slist *' argument */ +#define CURLOPTTYPE_SLISTPOINT CURLOPTTYPE_OBJECTPOINT + +/* 'void *' argument passed untouched to callback */ +#define CURLOPTTYPE_CBPOINT CURLOPTTYPE_OBJECTPOINT + +/* 'long' argument with a set of values/bitmask */ +#define CURLOPTTYPE_VALUES CURLOPTTYPE_LONG + +/* + * All CURLOPT_* values. + */ + +typedef enum { + /* This is the FILE * or void * the regular output should be written to. */ + CURLOPT(CURLOPT_WRITEDATA, CURLOPTTYPE_CBPOINT, 1), + + /* The full URL to get/put */ + CURLOPT(CURLOPT_URL, CURLOPTTYPE_STRINGPOINT, 2), + + /* Port number to connect to, if other than default. */ + CURLOPT(CURLOPT_PORT, CURLOPTTYPE_LONG, 3), + + /* Name of proxy to use. */ + CURLOPT(CURLOPT_PROXY, CURLOPTTYPE_STRINGPOINT, 4), + + /* "user:password;options" to use when fetching. */ + CURLOPT(CURLOPT_USERPWD, CURLOPTTYPE_STRINGPOINT, 5), + + /* "user:password" to use with proxy. */ + CURLOPT(CURLOPT_PROXYUSERPWD, CURLOPTTYPE_STRINGPOINT, 6), + + /* Range to get, specified as an ASCII string. */ + CURLOPT(CURLOPT_RANGE, CURLOPTTYPE_STRINGPOINT, 7), + + /* not used */ + + /* Specified file stream to upload from (use as input): */ + CURLOPT(CURLOPT_READDATA, CURLOPTTYPE_CBPOINT, 9), + + /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE + * bytes big. */ + CURLOPT(CURLOPT_ERRORBUFFER, CURLOPTTYPE_OBJECTPOINT, 10), + + /* Function that will be called to store the output (instead of fwrite). The + * parameters will use fwrite() syntax, make sure to follow them. */ + CURLOPT(CURLOPT_WRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 11), + + /* Function that will be called to read the input (instead of fread). The + * parameters will use fread() syntax, make sure to follow them. */ + CURLOPT(CURLOPT_READFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 12), + + /* Time-out the read operation after this amount of seconds */ + CURLOPT(CURLOPT_TIMEOUT, CURLOPTTYPE_LONG, 13), + + /* If CURLOPT_READDATA is used, this can be used to inform libcurl about + * how large the file being sent really is. That allows better error + * checking and better verifies that the upload was successful. -1 means + * unknown size. + * + * For large file support, there is also a _LARGE version of the key + * which takes an off_t type, allowing platforms with larger off_t + * sizes to handle larger files. See below for INFILESIZE_LARGE. + */ + CURLOPT(CURLOPT_INFILESIZE, CURLOPTTYPE_LONG, 14), + + /* POST static input fields. */ + CURLOPT(CURLOPT_POSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 15), + + /* Set the referrer page (needed by some CGIs) */ + CURLOPT(CURLOPT_REFERER, CURLOPTTYPE_STRINGPOINT, 16), + + /* Set the FTP PORT string (interface name, named or numerical IP address) + Use i.e '-' to use default address. */ + CURLOPT(CURLOPT_FTPPORT, CURLOPTTYPE_STRINGPOINT, 17), + + /* Set the User-Agent string (examined by some CGIs) */ + CURLOPT(CURLOPT_USERAGENT, CURLOPTTYPE_STRINGPOINT, 18), + + /* If the download receives less than "low speed limit" bytes/second + * during "low speed time" seconds, the operations is aborted. + * You could i.e if you have a pretty high speed connection, abort if + * it is less than 2000 bytes/sec during 20 seconds. + */ + + /* Set the "low speed limit" */ + CURLOPT(CURLOPT_LOW_SPEED_LIMIT, CURLOPTTYPE_LONG, 19), + + /* Set the "low speed time" */ + CURLOPT(CURLOPT_LOW_SPEED_TIME, CURLOPTTYPE_LONG, 20), + + /* Set the continuation offset. + * + * Note there is also a _LARGE version of this key which uses + * off_t types, allowing for large file offsets on platforms which + * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. + */ + CURLOPT(CURLOPT_RESUME_FROM, CURLOPTTYPE_LONG, 21), + + /* Set cookie in request: */ + CURLOPT(CURLOPT_COOKIE, CURLOPTTYPE_STRINGPOINT, 22), + + /* This points to a linked list of headers, struct curl_slist kind. This + list is also used for RTSP (in spite of its name) */ + CURLOPT(CURLOPT_HTTPHEADER, CURLOPTTYPE_SLISTPOINT, 23), + + /* This points to a linked list of post entries, struct curl_httppost */ + CURLOPTDEPRECATED(CURLOPT_HTTPPOST, CURLOPTTYPE_OBJECTPOINT, 24, + 7.56.0, "Use CURLOPT_MIMEPOST"), + + /* name of the file keeping your private SSL-certificate */ + CURLOPT(CURLOPT_SSLCERT, CURLOPTTYPE_STRINGPOINT, 25), + + /* password for the SSL or SSH private key */ + CURLOPT(CURLOPT_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 26), + + /* send TYPE parameter? */ + CURLOPT(CURLOPT_CRLF, CURLOPTTYPE_LONG, 27), + + /* send linked-list of QUOTE commands */ + CURLOPT(CURLOPT_QUOTE, CURLOPTTYPE_SLISTPOINT, 28), + + /* send FILE * or void * to store headers to, if you use a callback it + is simply passed to the callback unmodified */ + CURLOPT(CURLOPT_HEADERDATA, CURLOPTTYPE_CBPOINT, 29), + + /* point to a file to read the initial cookies from, also enables + "cookie awareness" */ + CURLOPT(CURLOPT_COOKIEFILE, CURLOPTTYPE_STRINGPOINT, 31), + + /* What version to specifically try to use. + See CURL_SSLVERSION defines below. */ + CURLOPT(CURLOPT_SSLVERSION, CURLOPTTYPE_VALUES, 32), + + /* What kind of HTTP time condition to use, see defines */ + CURLOPT(CURLOPT_TIMECONDITION, CURLOPTTYPE_VALUES, 33), + + /* Time to use with the above condition. Specified in number of seconds + since 1 Jan 1970 */ + CURLOPT(CURLOPT_TIMEVALUE, CURLOPTTYPE_LONG, 34), + + /* 35 = OBSOLETE */ + + /* Custom request, for customizing the get command like + HTTP: DELETE, TRACE and others + FTP: to use a different list command + */ + CURLOPT(CURLOPT_CUSTOMREQUEST, CURLOPTTYPE_STRINGPOINT, 36), + + /* FILE handle to use instead of stderr */ + CURLOPT(CURLOPT_STDERR, CURLOPTTYPE_OBJECTPOINT, 37), + + /* 38 is not used */ + + /* send linked-list of post-transfer QUOTE commands */ + CURLOPT(CURLOPT_POSTQUOTE, CURLOPTTYPE_SLISTPOINT, 39), + + /* 40 is not used */ + + /* talk a lot */ + CURLOPT(CURLOPT_VERBOSE, CURLOPTTYPE_LONG, 41), + + /* throw the header out too */ + CURLOPT(CURLOPT_HEADER, CURLOPTTYPE_LONG, 42), + + /* shut off the progress meter */ + CURLOPT(CURLOPT_NOPROGRESS, CURLOPTTYPE_LONG, 43), + + /* use HEAD to get http document */ + CURLOPT(CURLOPT_NOBODY, CURLOPTTYPE_LONG, 44), + + /* no output on http error codes >= 400 */ + CURLOPT(CURLOPT_FAILONERROR, CURLOPTTYPE_LONG, 45), + + /* this is an upload */ + CURLOPT(CURLOPT_UPLOAD, CURLOPTTYPE_LONG, 46), + + /* HTTP POST method */ + CURLOPT(CURLOPT_POST, CURLOPTTYPE_LONG, 47), + + /* bare names when listing directories */ + CURLOPT(CURLOPT_DIRLISTONLY, CURLOPTTYPE_LONG, 48), + + /* Append instead of overwrite on upload! */ + CURLOPT(CURLOPT_APPEND, CURLOPTTYPE_LONG, 50), + + /* Specify whether to read the user+password from the .netrc or the URL. + * This must be one of the CURL_NETRC_* enums below. */ + CURLOPT(CURLOPT_NETRC, CURLOPTTYPE_VALUES, 51), + + /* use Location: Luke! */ + CURLOPT(CURLOPT_FOLLOWLOCATION, CURLOPTTYPE_LONG, 52), + + /* transfer data in text/ASCII format */ + CURLOPT(CURLOPT_TRANSFERTEXT, CURLOPTTYPE_LONG, 53), + + /* HTTP PUT */ + CURLOPTDEPRECATED(CURLOPT_PUT, CURLOPTTYPE_LONG, 54, + 7.12.1, "Use CURLOPT_UPLOAD"), + + /* 55 = OBSOLETE */ + + /* DEPRECATED + * Function that will be called instead of the internal progress display + * function. This function should be defined as the curl_progress_callback + * prototype defines. */ + CURLOPTDEPRECATED(CURLOPT_PROGRESSFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 56, + 7.32.0, "Use CURLOPT_XFERINFOFUNCTION"), + + /* Data passed to the CURLOPT_PROGRESSFUNCTION and CURLOPT_XFERINFOFUNCTION + callbacks */ + CURLOPT(CURLOPT_XFERINFODATA, CURLOPTTYPE_CBPOINT, 57), +#define CURLOPT_PROGRESSDATA CURLOPT_XFERINFODATA + + /* We want the referrer field set automatically when following locations */ + CURLOPT(CURLOPT_AUTOREFERER, CURLOPTTYPE_LONG, 58), + + /* Port of the proxy, can be set in the proxy string as well with: + "[host]:[port]" */ + CURLOPT(CURLOPT_PROXYPORT, CURLOPTTYPE_LONG, 59), + + /* size of the POST input data, if strlen() is not good to use */ + CURLOPT(CURLOPT_POSTFIELDSIZE, CURLOPTTYPE_LONG, 60), + + /* tunnel non-http operations through an HTTP proxy */ + CURLOPT(CURLOPT_HTTPPROXYTUNNEL, CURLOPTTYPE_LONG, 61), + + /* Set the interface string to use as outgoing network interface */ + CURLOPT(CURLOPT_INTERFACE, CURLOPTTYPE_STRINGPOINT, 62), + + /* Set the krb4/5 security level, this also enables krb4/5 awareness. This + * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string + * is set but does not match one of these, 'private' will be used. */ + CURLOPT(CURLOPT_KRBLEVEL, CURLOPTTYPE_STRINGPOINT, 63), + + /* Set if we should verify the peer in ssl handshake, set 1 to verify. */ + CURLOPT(CURLOPT_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 64), + + /* The CApath or CAfile used to validate the peer certificate + this option is used only if SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_CAINFO, CURLOPTTYPE_STRINGPOINT, 65), + + /* 66 = OBSOLETE */ + /* 67 = OBSOLETE */ + + /* Maximum number of http redirects to follow */ + CURLOPT(CURLOPT_MAXREDIRS, CURLOPTTYPE_LONG, 68), + + /* Pass a long set to 1 to get the date of the requested document (if + possible)! Pass a zero to shut it off. */ + CURLOPT(CURLOPT_FILETIME, CURLOPTTYPE_LONG, 69), + + /* This points to a linked list of telnet options */ + CURLOPT(CURLOPT_TELNETOPTIONS, CURLOPTTYPE_SLISTPOINT, 70), + + /* Max amount of cached alive connections */ + CURLOPT(CURLOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 71), + + /* 72 = OBSOLETE */ + /* 73 = OBSOLETE */ + + /* Set to explicitly use a new connection for the upcoming transfer. + Do not use this unless you are absolutely sure of this, as it makes the + operation slower and is less friendly for the network. */ + CURLOPT(CURLOPT_FRESH_CONNECT, CURLOPTTYPE_LONG, 74), + + /* Set to explicitly forbid the upcoming transfer's connection to be reused + when done. Do not use this unless you are absolutely sure of this, as it + makes the operation slower and is less friendly for the network. */ + CURLOPT(CURLOPT_FORBID_REUSE, CURLOPTTYPE_LONG, 75), + + /* Set to a filename that contains random data for libcurl to use to + seed the random engine when doing SSL connects. */ + CURLOPTDEPRECATED(CURLOPT_RANDOM_FILE, CURLOPTTYPE_STRINGPOINT, 76, + 7.84.0, "Serves no purpose anymore"), + + /* Set to the Entropy Gathering Daemon socket pathname */ + CURLOPTDEPRECATED(CURLOPT_EGDSOCKET, CURLOPTTYPE_STRINGPOINT, 77, + 7.84.0, "Serves no purpose anymore"), + + /* Time-out connect operations after this amount of seconds, if connects are + OK within this time, then fine... This only aborts the connect phase. */ + CURLOPT(CURLOPT_CONNECTTIMEOUT, CURLOPTTYPE_LONG, 78), + + /* Function that will be called to store headers (instead of fwrite). The + * parameters will use fwrite() syntax, make sure to follow them. */ + CURLOPT(CURLOPT_HEADERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 79), + + /* Set this to force the HTTP request to get back to GET. Only really usable + if POST, PUT or a custom request have been used first. + */ + CURLOPT(CURLOPT_HTTPGET, CURLOPTTYPE_LONG, 80), + + /* Set if we should verify the Common name from the peer certificate in ssl + * handshake, set 1 to check existence, 2 to ensure that it matches the + * provided hostname. */ + CURLOPT(CURLOPT_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 81), + + /* Specify which filename to write all known cookies in after completed + operation. Set filename to "-" (dash) to make it go to stdout. */ + CURLOPT(CURLOPT_COOKIEJAR, CURLOPTTYPE_STRINGPOINT, 82), + + /* Specify which TLS 1.2 (1.1, 1.0) ciphers to use */ + CURLOPT(CURLOPT_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 83), + + /* Specify which HTTP version to use! This must be set to one of the + CURL_HTTP_VERSION* enums set below. */ + CURLOPT(CURLOPT_HTTP_VERSION, CURLOPTTYPE_VALUES, 84), + + /* Specifically switch on or off the FTP engine's use of the EPSV command. By + default, that one will always be attempted before the more traditional + PASV command. */ + CURLOPT(CURLOPT_FTP_USE_EPSV, CURLOPTTYPE_LONG, 85), + + /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */ + CURLOPT(CURLOPT_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 86), + + /* name of the file keeping your private SSL-key */ + CURLOPT(CURLOPT_SSLKEY, CURLOPTTYPE_STRINGPOINT, 87), + + /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */ + CURLOPT(CURLOPT_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 88), + + /* crypto engine for the SSL-sub system */ + CURLOPT(CURLOPT_SSLENGINE, CURLOPTTYPE_STRINGPOINT, 89), + + /* set the crypto engine for the SSL-sub system as default + the param has no meaning... + */ + CURLOPT(CURLOPT_SSLENGINE_DEFAULT, CURLOPTTYPE_LONG, 90), + + /* Non-zero value means to use the global dns cache */ + /* DEPRECATED, do not use! */ + CURLOPTDEPRECATED(CURLOPT_DNS_USE_GLOBAL_CACHE, CURLOPTTYPE_LONG, 91, + 7.11.1, "Use CURLOPT_SHARE"), + + /* DNS cache timeout */ + CURLOPT(CURLOPT_DNS_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 92), + + /* send linked-list of pre-transfer QUOTE commands */ + CURLOPT(CURLOPT_PREQUOTE, CURLOPTTYPE_SLISTPOINT, 93), + + /* set the debug function */ + CURLOPT(CURLOPT_DEBUGFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 94), + + /* set the data for the debug function */ + CURLOPT(CURLOPT_DEBUGDATA, CURLOPTTYPE_CBPOINT, 95), + + /* mark this as start of a cookie session */ + CURLOPT(CURLOPT_COOKIESESSION, CURLOPTTYPE_LONG, 96), + + /* The CApath directory used to validate the peer certificate + this option is used only if SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_CAPATH, CURLOPTTYPE_STRINGPOINT, 97), + + /* Instruct libcurl to use a smaller receive buffer */ + CURLOPT(CURLOPT_BUFFERSIZE, CURLOPTTYPE_LONG, 98), + + /* Instruct libcurl to not use any signal/alarm handlers, even when using + timeouts. This option is useful for multi-threaded applications. + See libcurl-the-guide for more background information. */ + CURLOPT(CURLOPT_NOSIGNAL, CURLOPTTYPE_LONG, 99), + + /* Provide a CURLShare for mutexing non-ts data */ + CURLOPT(CURLOPT_SHARE, CURLOPTTYPE_OBJECTPOINT, 100), + + /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default), + CURLPROXY_HTTPS, CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and + CURLPROXY_SOCKS5. */ + CURLOPT(CURLOPT_PROXYTYPE, CURLOPTTYPE_VALUES, 101), + + /* Set the Accept-Encoding string. Use this to tell a server you would like + the response to be compressed. Before 7.21.6, this was known as + CURLOPT_ENCODING */ + CURLOPT(CURLOPT_ACCEPT_ENCODING, CURLOPTTYPE_STRINGPOINT, 102), + + /* Set pointer to private data */ + CURLOPT(CURLOPT_PRIVATE, CURLOPTTYPE_OBJECTPOINT, 103), + + /* Set aliases for HTTP 200 in the HTTP Response header */ + CURLOPT(CURLOPT_HTTP200ALIASES, CURLOPTTYPE_SLISTPOINT, 104), + + /* Continue to send authentication (user+password) when following locations, + even when hostname changed. This can potentially send off the name + and password to whatever host the server decides. */ + CURLOPT(CURLOPT_UNRESTRICTED_AUTH, CURLOPTTYPE_LONG, 105), + + /* Specifically switch on or off the FTP engine's use of the EPRT command ( + it also disables the LPRT attempt). By default, those ones will always be + attempted before the good old traditional PORT command. */ + CURLOPT(CURLOPT_FTP_USE_EPRT, CURLOPTTYPE_LONG, 106), + + /* Set this to a bitmask value to enable the particular authentications + methods you like. Use this in combination with CURLOPT_USERPWD. + Note that setting multiple bits may cause extra network round-trips. */ + CURLOPT(CURLOPT_HTTPAUTH, CURLOPTTYPE_VALUES, 107), + + /* Set the ssl context callback function, currently only for OpenSSL or + wolfSSL ssl_ctx, or mbedTLS mbedtls_ssl_config in the second argument. + The function must match the curl_ssl_ctx_callback prototype. */ + CURLOPT(CURLOPT_SSL_CTX_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 108), + + /* Set the userdata for the ssl context callback function's third + argument */ + CURLOPT(CURLOPT_SSL_CTX_DATA, CURLOPTTYPE_CBPOINT, 109), + + /* FTP Option that causes missing dirs to be created on the remote server. + In 7.19.4 we introduced the convenience enums for this option using the + CURLFTP_CREATE_DIR prefix. + */ + CURLOPT(CURLOPT_FTP_CREATE_MISSING_DIRS, CURLOPTTYPE_LONG, 110), + + /* Set this to a bitmask value to enable the particular authentications + methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. + Note that setting multiple bits may cause extra network round-trips. */ + CURLOPT(CURLOPT_PROXYAUTH, CURLOPTTYPE_VALUES, 111), + + /* Option that changes the timeout, in seconds, associated with getting a + response. This is different from transfer timeout time and essentially + places a demand on the server to acknowledge commands in a timely + manner. For FTP, SMTP, IMAP and POP3. */ + CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT, CURLOPTTYPE_LONG, 112), + + /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to + tell libcurl to use those IP versions only. This only has effect on + systems with support for more than one, i.e IPv4 _and_ IPv6. */ + CURLOPT(CURLOPT_IPRESOLVE, CURLOPTTYPE_VALUES, 113), + + /* Set this option to limit the size of a file that will be downloaded from + an HTTP or FTP server. + + Note there is also _LARGE version which adds large file support for + platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */ + CURLOPT(CURLOPT_MAXFILESIZE, CURLOPTTYPE_LONG, 114), + + /* See the comment for INFILESIZE above, but in short, specifies + * the size of the file being uploaded. -1 means unknown. + */ + CURLOPT(CURLOPT_INFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 115), + + /* Sets the continuation offset. There is also a CURLOPTTYPE_LONG version + * of this; look above for RESUME_FROM. + */ + CURLOPT(CURLOPT_RESUME_FROM_LARGE, CURLOPTTYPE_OFF_T, 116), + + /* Sets the maximum size of data that will be downloaded from + * an HTTP or FTP server. See MAXFILESIZE above for the LONG version. + */ + CURLOPT(CURLOPT_MAXFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 117), + + /* Set this option to the filename of your .netrc file you want libcurl + to parse (using the CURLOPT_NETRC option). If not set, libcurl will do + a poor attempt to find the user's home directory and check for a .netrc + file in there. */ + CURLOPT(CURLOPT_NETRC_FILE, CURLOPTTYPE_STRINGPOINT, 118), + + /* Enable SSL/TLS for FTP, pick one of: + CURLUSESSL_TRY - try using SSL, proceed anyway otherwise + CURLUSESSL_CONTROL - SSL for the control connection or fail + CURLUSESSL_ALL - SSL for all communication or fail + */ + CURLOPT(CURLOPT_USE_SSL, CURLOPTTYPE_VALUES, 119), + + /* The _LARGE version of the standard POSTFIELDSIZE option */ + CURLOPT(CURLOPT_POSTFIELDSIZE_LARGE, CURLOPTTYPE_OFF_T, 120), + + /* Enable/disable the TCP Nagle algorithm */ + CURLOPT(CURLOPT_TCP_NODELAY, CURLOPTTYPE_LONG, 121), + + /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 123 OBSOLETE. Gone in 7.16.0 */ + /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 127 OBSOLETE. Gone in 7.16.0 */ + /* 128 OBSOLETE. Gone in 7.16.0 */ + + /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option + can be used to change libcurl's default action which is to first try + "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK + response has been received. + + Available parameters are: + CURLFTPAUTH_DEFAULT - let libcurl decide + CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS + CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL + */ + CURLOPT(CURLOPT_FTPSSLAUTH, CURLOPTTYPE_VALUES, 129), + + CURLOPTDEPRECATED(CURLOPT_IOCTLFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 130, + 7.18.0, "Use CURLOPT_SEEKFUNCTION"), + CURLOPTDEPRECATED(CURLOPT_IOCTLDATA, CURLOPTTYPE_CBPOINT, 131, + 7.18.0, "Use CURLOPT_SEEKDATA"), + + /* 132 OBSOLETE. Gone in 7.16.0 */ + /* 133 OBSOLETE. Gone in 7.16.0 */ + + /* null-terminated string for pass on to the FTP server when asked for + "account" info */ + CURLOPT(CURLOPT_FTP_ACCOUNT, CURLOPTTYPE_STRINGPOINT, 134), + + /* feed cookie into cookie engine */ + CURLOPT(CURLOPT_COOKIELIST, CURLOPTTYPE_STRINGPOINT, 135), + + /* ignore Content-Length */ + CURLOPT(CURLOPT_IGNORE_CONTENT_LENGTH, CURLOPTTYPE_LONG, 136), + + /* Set to non-zero to skip the IP address received in a 227 PASV FTP server + response. Typically used for FTP-SSL purposes but is not restricted to + that. libcurl will then instead use the same IP address it used for the + control connection. */ + CURLOPT(CURLOPT_FTP_SKIP_PASV_IP, CURLOPTTYPE_LONG, 137), + + /* Select "file method" to use when doing FTP, see the curl_ftpmethod + above. */ + CURLOPT(CURLOPT_FTP_FILEMETHOD, CURLOPTTYPE_VALUES, 138), + + /* Local port number to bind the socket to */ + CURLOPT(CURLOPT_LOCALPORT, CURLOPTTYPE_LONG, 139), + + /* Number of ports to try, including the first one set with LOCALPORT. + Thus, setting it to 1 will make no additional attempts but the first. + */ + CURLOPT(CURLOPT_LOCALPORTRANGE, CURLOPTTYPE_LONG, 140), + + /* no transfer, set up connection and let application use the socket by + extracting it with CURLINFO_LASTSOCKET */ + CURLOPT(CURLOPT_CONNECT_ONLY, CURLOPTTYPE_LONG, 141), + + /* Function that will be called to convert from the + network encoding (instead of using the iconv calls in libcurl) */ + CURLOPTDEPRECATED(CURLOPT_CONV_FROM_NETWORK_FUNCTION, + CURLOPTTYPE_FUNCTIONPOINT, 142, + 7.82.0, "Serves no purpose anymore"), + + /* Function that will be called to convert to the + network encoding (instead of using the iconv calls in libcurl) */ + CURLOPTDEPRECATED(CURLOPT_CONV_TO_NETWORK_FUNCTION, + CURLOPTTYPE_FUNCTIONPOINT, 143, + 7.82.0, "Serves no purpose anymore"), + + /* Function that will be called to convert from UTF8 + (instead of using the iconv calls in libcurl) + Note that this is used only for SSL certificate processing */ + CURLOPTDEPRECATED(CURLOPT_CONV_FROM_UTF8_FUNCTION, + CURLOPTTYPE_FUNCTIONPOINT, 144, + 7.82.0, "Serves no purpose anymore"), + + /* if the connection proceeds too quickly then need to slow it down */ + /* limit-rate: maximum number of bytes per second to send or receive */ + CURLOPT(CURLOPT_MAX_SEND_SPEED_LARGE, CURLOPTTYPE_OFF_T, 145), + CURLOPT(CURLOPT_MAX_RECV_SPEED_LARGE, CURLOPTTYPE_OFF_T, 146), + + /* Pointer to command string to send if USER/PASS fails. */ + CURLOPT(CURLOPT_FTP_ALTERNATIVE_TO_USER, CURLOPTTYPE_STRINGPOINT, 147), + + /* callback function for setting socket options */ + CURLOPT(CURLOPT_SOCKOPTFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 148), + CURLOPT(CURLOPT_SOCKOPTDATA, CURLOPTTYPE_CBPOINT, 149), + + /* set to 0 to disable session ID reuse for this transfer, default is + enabled (== 1) */ + CURLOPT(CURLOPT_SSL_SESSIONID_CACHE, CURLOPTTYPE_LONG, 150), + + /* allowed SSH authentication methods */ + CURLOPT(CURLOPT_SSH_AUTH_TYPES, CURLOPTTYPE_VALUES, 151), + + /* Used by scp/sftp to do public/private key authentication */ + CURLOPT(CURLOPT_SSH_PUBLIC_KEYFILE, CURLOPTTYPE_STRINGPOINT, 152), + CURLOPT(CURLOPT_SSH_PRIVATE_KEYFILE, CURLOPTTYPE_STRINGPOINT, 153), + + /* Send CCC (Clear Command Channel) after authentication */ + CURLOPT(CURLOPT_FTP_SSL_CCC, CURLOPTTYPE_LONG, 154), + + /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */ + CURLOPT(CURLOPT_TIMEOUT_MS, CURLOPTTYPE_LONG, 155), + CURLOPT(CURLOPT_CONNECTTIMEOUT_MS, CURLOPTTYPE_LONG, 156), + + /* set to zero to disable the libcurl's decoding and thus pass the raw body + data to the application even when it is encoded/compressed */ + CURLOPT(CURLOPT_HTTP_TRANSFER_DECODING, CURLOPTTYPE_LONG, 157), + CURLOPT(CURLOPT_HTTP_CONTENT_DECODING, CURLOPTTYPE_LONG, 158), + + /* Permission used when creating new files and directories on the remote + server for protocols that support it, SFTP/SCP/FILE */ + CURLOPT(CURLOPT_NEW_FILE_PERMS, CURLOPTTYPE_LONG, 159), + CURLOPT(CURLOPT_NEW_DIRECTORY_PERMS, CURLOPTTYPE_LONG, 160), + + /* Set the behavior of POST when redirecting. Values must be set to one + of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */ + CURLOPT(CURLOPT_POSTREDIR, CURLOPTTYPE_VALUES, 161), + + /* used by scp/sftp to verify the host's public key */ + CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_MD5, CURLOPTTYPE_STRINGPOINT, 162), + + /* Callback function for opening socket (instead of socket(2)). Optionally, + callback is able change the address or refuse to connect returning + CURL_SOCKET_BAD. The callback should have type + curl_opensocket_callback */ + CURLOPT(CURLOPT_OPENSOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 163), + CURLOPT(CURLOPT_OPENSOCKETDATA, CURLOPTTYPE_CBPOINT, 164), + + /* POST volatile input fields. */ + CURLOPT(CURLOPT_COPYPOSTFIELDS, CURLOPTTYPE_OBJECTPOINT, 165), + + /* set transfer mode (;type=) when doing FTP via an HTTP proxy */ + CURLOPT(CURLOPT_PROXY_TRANSFER_MODE, CURLOPTTYPE_LONG, 166), + + /* Callback function for seeking in the input stream */ + CURLOPT(CURLOPT_SEEKFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 167), + CURLOPT(CURLOPT_SEEKDATA, CURLOPTTYPE_CBPOINT, 168), + + /* CRL file */ + CURLOPT(CURLOPT_CRLFILE, CURLOPTTYPE_STRINGPOINT, 169), + + /* Issuer certificate */ + CURLOPT(CURLOPT_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 170), + + /* (IPv6) Address scope */ + CURLOPT(CURLOPT_ADDRESS_SCOPE, CURLOPTTYPE_LONG, 171), + + /* Collect certificate chain info and allow it to get retrievable with + CURLINFO_CERTINFO after the transfer is complete. */ + CURLOPT(CURLOPT_CERTINFO, CURLOPTTYPE_LONG, 172), + + /* "name" and "pwd" to use when fetching. */ + CURLOPT(CURLOPT_USERNAME, CURLOPTTYPE_STRINGPOINT, 173), + CURLOPT(CURLOPT_PASSWORD, CURLOPTTYPE_STRINGPOINT, 174), + + /* "name" and "pwd" to use with Proxy when fetching. */ + CURLOPT(CURLOPT_PROXYUSERNAME, CURLOPTTYPE_STRINGPOINT, 175), + CURLOPT(CURLOPT_PROXYPASSWORD, CURLOPTTYPE_STRINGPOINT, 176), + + /* Comma separated list of hostnames defining no-proxy zones. These should + match both hostnames directly, and hostnames within a domain. For + example, local.com will match local.com and www.local.com, but NOT + notlocal.com or www.notlocal.com. For compatibility with other + implementations of this, .local.com will be considered to be the same as + local.com. A single * is the only valid wildcard, and effectively + disables the use of proxy. */ + CURLOPT(CURLOPT_NOPROXY, CURLOPTTYPE_STRINGPOINT, 177), + + /* block size for TFTP transfers */ + CURLOPT(CURLOPT_TFTP_BLKSIZE, CURLOPTTYPE_LONG, 178), + + /* Socks Service */ + /* DEPRECATED, do not use! */ + CURLOPTDEPRECATED(CURLOPT_SOCKS5_GSSAPI_SERVICE, + CURLOPTTYPE_STRINGPOINT, 179, + 7.49.0, "Use CURLOPT_PROXY_SERVICE_NAME"), + + /* Socks Service */ + CURLOPT(CURLOPT_SOCKS5_GSSAPI_NEC, CURLOPTTYPE_LONG, 180), + + /* set the bitmask for the protocols that are allowed to be used for the + transfer, which thus helps the app which takes URLs from users or other + external inputs and want to restrict what protocol(s) to deal + with. Defaults to CURLPROTO_ALL. */ + CURLOPTDEPRECATED(CURLOPT_PROTOCOLS, CURLOPTTYPE_LONG, 181, + 7.85.0, "Use CURLOPT_PROTOCOLS_STR"), + + /* set the bitmask for the protocols that libcurl is allowed to follow to, + as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs + to be set in both bitmasks to be allowed to get redirected to. */ + CURLOPTDEPRECATED(CURLOPT_REDIR_PROTOCOLS, CURLOPTTYPE_LONG, 182, + 7.85.0, "Use CURLOPT_REDIR_PROTOCOLS_STR"), + + /* set the SSH knownhost filename to use */ + CURLOPT(CURLOPT_SSH_KNOWNHOSTS, CURLOPTTYPE_STRINGPOINT, 183), + + /* set the SSH host key callback, must point to a curl_sshkeycallback + function */ + CURLOPT(CURLOPT_SSH_KEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 184), + + /* set the SSH host key callback custom pointer */ + CURLOPT(CURLOPT_SSH_KEYDATA, CURLOPTTYPE_CBPOINT, 185), + + /* set the SMTP mail originator */ + CURLOPT(CURLOPT_MAIL_FROM, CURLOPTTYPE_STRINGPOINT, 186), + + /* set the list of SMTP mail receiver(s) */ + CURLOPT(CURLOPT_MAIL_RCPT, CURLOPTTYPE_SLISTPOINT, 187), + + /* FTP: send PRET before PASV */ + CURLOPT(CURLOPT_FTP_USE_PRET, CURLOPTTYPE_LONG, 188), + + /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */ + CURLOPT(CURLOPT_RTSP_REQUEST, CURLOPTTYPE_VALUES, 189), + + /* The RTSP session identifier */ + CURLOPT(CURLOPT_RTSP_SESSION_ID, CURLOPTTYPE_STRINGPOINT, 190), + + /* The RTSP stream URI */ + CURLOPT(CURLOPT_RTSP_STREAM_URI, CURLOPTTYPE_STRINGPOINT, 191), + + /* The Transport: header to use in RTSP requests */ + CURLOPT(CURLOPT_RTSP_TRANSPORT, CURLOPTTYPE_STRINGPOINT, 192), + + /* Manually initialize the client RTSP CSeq for this handle */ + CURLOPT(CURLOPT_RTSP_CLIENT_CSEQ, CURLOPTTYPE_LONG, 193), + + /* Manually initialize the server RTSP CSeq for this handle */ + CURLOPT(CURLOPT_RTSP_SERVER_CSEQ, CURLOPTTYPE_LONG, 194), + + /* The stream to pass to INTERLEAVEFUNCTION. */ + CURLOPT(CURLOPT_INTERLEAVEDATA, CURLOPTTYPE_CBPOINT, 195), + + /* Let the application define a custom write method for RTP data */ + CURLOPT(CURLOPT_INTERLEAVEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 196), + + /* Turn on wildcard matching */ + CURLOPT(CURLOPT_WILDCARDMATCH, CURLOPTTYPE_LONG, 197), + + /* Directory matching callback called before downloading of an + individual file (chunk) started */ + CURLOPT(CURLOPT_CHUNK_BGN_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 198), + + /* Directory matching callback called after the file (chunk) + was downloaded, or skipped */ + CURLOPT(CURLOPT_CHUNK_END_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 199), + + /* Change match (fnmatch-like) callback for wildcard matching */ + CURLOPT(CURLOPT_FNMATCH_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 200), + + /* Let the application define custom chunk data pointer */ + CURLOPT(CURLOPT_CHUNK_DATA, CURLOPTTYPE_CBPOINT, 201), + + /* FNMATCH_FUNCTION user pointer */ + CURLOPT(CURLOPT_FNMATCH_DATA, CURLOPTTYPE_CBPOINT, 202), + + /* send linked-list of name:port:address sets */ + CURLOPT(CURLOPT_RESOLVE, CURLOPTTYPE_SLISTPOINT, 203), + + /* Set a username for authenticated TLS */ + CURLOPT(CURLOPT_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 204), + + /* Set a password for authenticated TLS */ + CURLOPT(CURLOPT_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 205), + + /* Set authentication type for authenticated TLS */ + CURLOPT(CURLOPT_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 206), + + /* Set to 1 to enable the "TE:" header in HTTP requests to ask for + compressed transfer-encoded responses. Set to 0 to disable the use of TE: + in outgoing requests. The current default is 0, but it might change in a + future libcurl release. + + libcurl will ask for the compressed methods it knows of, and if that + is not any, it will not ask for transfer-encoding at all even if this + option is set to 1. + + */ + CURLOPT(CURLOPT_TRANSFER_ENCODING, CURLOPTTYPE_LONG, 207), + + /* Callback function for closing socket (instead of close(2)). The callback + should have type curl_closesocket_callback */ + CURLOPT(CURLOPT_CLOSESOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 208), + CURLOPT(CURLOPT_CLOSESOCKETDATA, CURLOPTTYPE_CBPOINT, 209), + + /* allow GSSAPI credential delegation */ + CURLOPT(CURLOPT_GSSAPI_DELEGATION, CURLOPTTYPE_VALUES, 210), + + /* Set the name servers to use for DNS resolution. + * Only supported by the c-ares DNS backend */ + CURLOPT(CURLOPT_DNS_SERVERS, CURLOPTTYPE_STRINGPOINT, 211), + + /* Time-out accept operations (currently for FTP only) after this amount + of milliseconds. */ + CURLOPT(CURLOPT_ACCEPTTIMEOUT_MS, CURLOPTTYPE_LONG, 212), + + /* Set TCP keepalive */ + CURLOPT(CURLOPT_TCP_KEEPALIVE, CURLOPTTYPE_LONG, 213), + + /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */ + CURLOPT(CURLOPT_TCP_KEEPIDLE, CURLOPTTYPE_LONG, 214), + CURLOPT(CURLOPT_TCP_KEEPINTVL, CURLOPTTYPE_LONG, 215), + + /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */ + CURLOPT(CURLOPT_SSL_OPTIONS, CURLOPTTYPE_VALUES, 216), + + /* Set the SMTP auth originator */ + CURLOPT(CURLOPT_MAIL_AUTH, CURLOPTTYPE_STRINGPOINT, 217), + + /* Enable/disable SASL initial response */ + CURLOPT(CURLOPT_SASL_IR, CURLOPTTYPE_LONG, 218), + + /* Function that will be called instead of the internal progress display + * function. This function should be defined as the curl_xferinfo_callback + * prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */ + CURLOPT(CURLOPT_XFERINFOFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 219), + + /* The XOAUTH2 bearer token */ + CURLOPT(CURLOPT_XOAUTH2_BEARER, CURLOPTTYPE_STRINGPOINT, 220), + + /* Set the interface string to use as outgoing network + * interface for DNS requests. + * Only supported by the c-ares DNS backend */ + CURLOPT(CURLOPT_DNS_INTERFACE, CURLOPTTYPE_STRINGPOINT, 221), + + /* Set the local IPv4 address to use for outgoing DNS requests. + * Only supported by the c-ares DNS backend */ + CURLOPT(CURLOPT_DNS_LOCAL_IP4, CURLOPTTYPE_STRINGPOINT, 222), + + /* Set the local IPv6 address to use for outgoing DNS requests. + * Only supported by the c-ares DNS backend */ + CURLOPT(CURLOPT_DNS_LOCAL_IP6, CURLOPTTYPE_STRINGPOINT, 223), + + /* Set authentication options directly */ + CURLOPT(CURLOPT_LOGIN_OPTIONS, CURLOPTTYPE_STRINGPOINT, 224), + + /* Enable/disable TLS NPN extension (http2 over ssl might fail without) */ + CURLOPTDEPRECATED(CURLOPT_SSL_ENABLE_NPN, CURLOPTTYPE_LONG, 225, + 7.86.0, "Has no function"), + + /* Enable/disable TLS ALPN extension (http2 over ssl might fail without) */ + CURLOPT(CURLOPT_SSL_ENABLE_ALPN, CURLOPTTYPE_LONG, 226), + + /* Time to wait for a response to an HTTP request containing an + * Expect: 100-continue header before sending the data anyway. */ + CURLOPT(CURLOPT_EXPECT_100_TIMEOUT_MS, CURLOPTTYPE_LONG, 227), + + /* This points to a linked list of headers used for proxy requests only, + struct curl_slist kind */ + CURLOPT(CURLOPT_PROXYHEADER, CURLOPTTYPE_SLISTPOINT, 228), + + /* Pass in a bitmask of "header options" */ + CURLOPT(CURLOPT_HEADEROPT, CURLOPTTYPE_VALUES, 229), + + /* The public key in DER form used to validate the peer public key + this option is used only if SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 230), + + /* Path to Unix domain socket */ + CURLOPT(CURLOPT_UNIX_SOCKET_PATH, CURLOPTTYPE_STRINGPOINT, 231), + + /* Set if we should verify the certificate status. */ + CURLOPT(CURLOPT_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 232), + + /* Set if we should enable TLS false start. */ + CURLOPTDEPRECATED(CURLOPT_SSL_FALSESTART, CURLOPTTYPE_LONG, 233, + 8.15.0, "Has no function"), + + /* Do not squash dot-dot sequences */ + CURLOPT(CURLOPT_PATH_AS_IS, CURLOPTTYPE_LONG, 234), + + /* Proxy Service Name */ + CURLOPT(CURLOPT_PROXY_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 235), + + /* Service Name */ + CURLOPT(CURLOPT_SERVICE_NAME, CURLOPTTYPE_STRINGPOINT, 236), + + /* Wait/do not wait for pipe/mutex to clarify */ + CURLOPT(CURLOPT_PIPEWAIT, CURLOPTTYPE_LONG, 237), + + /* Set the protocol used when curl is given a URL without a protocol */ + CURLOPT(CURLOPT_DEFAULT_PROTOCOL, CURLOPTTYPE_STRINGPOINT, 238), + + /* Set stream weight, 1 - 256 (default is 16) */ + CURLOPT(CURLOPT_STREAM_WEIGHT, CURLOPTTYPE_LONG, 239), + + /* Set stream dependency on another curl handle */ + CURLOPT(CURLOPT_STREAM_DEPENDS, CURLOPTTYPE_OBJECTPOINT, 240), + + /* Set E-xclusive stream dependency on another curl handle */ + CURLOPT(CURLOPT_STREAM_DEPENDS_E, CURLOPTTYPE_OBJECTPOINT, 241), + + /* Do not send any tftp option requests to the server */ + CURLOPT(CURLOPT_TFTP_NO_OPTIONS, CURLOPTTYPE_LONG, 242), + + /* Linked-list of host:port:connect-to-host:connect-to-port, + overrides the URL's host:port (only for the network layer) */ + CURLOPT(CURLOPT_CONNECT_TO, CURLOPTTYPE_SLISTPOINT, 243), + + /* Set TCP Fast Open */ + CURLOPT(CURLOPT_TCP_FASTOPEN, CURLOPTTYPE_LONG, 244), + + /* Continue to send data if the server responds early with an + * HTTP status code >= 300 */ + CURLOPT(CURLOPT_KEEP_SENDING_ON_ERROR, CURLOPTTYPE_LONG, 245), + + /* The CApath or CAfile used to validate the proxy certificate + this option is used only if PROXY_SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_PROXY_CAINFO, CURLOPTTYPE_STRINGPOINT, 246), + + /* The CApath directory used to validate the proxy certificate + this option is used only if PROXY_SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_PROXY_CAPATH, CURLOPTTYPE_STRINGPOINT, 247), + + /* Set if we should verify the proxy in ssl handshake, + set 1 to verify. */ + CURLOPT(CURLOPT_PROXY_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 248), + + /* Set if we should verify the Common name from the proxy certificate in ssl + * handshake, set 1 to check existence, 2 to ensure that it matches + * the provided hostname. */ + CURLOPT(CURLOPT_PROXY_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 249), + + /* What version to specifically try to use for proxy. + See CURL_SSLVERSION defines below. */ + CURLOPT(CURLOPT_PROXY_SSLVERSION, CURLOPTTYPE_VALUES, 250), + + /* Set a username for authenticated TLS for proxy */ + CURLOPT(CURLOPT_PROXY_TLSAUTH_USERNAME, CURLOPTTYPE_STRINGPOINT, 251), + + /* Set a password for authenticated TLS for proxy */ + CURLOPT(CURLOPT_PROXY_TLSAUTH_PASSWORD, CURLOPTTYPE_STRINGPOINT, 252), + + /* Set authentication type for authenticated TLS for proxy */ + CURLOPT(CURLOPT_PROXY_TLSAUTH_TYPE, CURLOPTTYPE_STRINGPOINT, 253), + + /* name of the file keeping your private SSL-certificate for proxy */ + CURLOPT(CURLOPT_PROXY_SSLCERT, CURLOPTTYPE_STRINGPOINT, 254), + + /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") for + proxy */ + CURLOPT(CURLOPT_PROXY_SSLCERTTYPE, CURLOPTTYPE_STRINGPOINT, 255), + + /* name of the file keeping your private SSL-key for proxy */ + CURLOPT(CURLOPT_PROXY_SSLKEY, CURLOPTTYPE_STRINGPOINT, 256), + + /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") for + proxy */ + CURLOPT(CURLOPT_PROXY_SSLKEYTYPE, CURLOPTTYPE_STRINGPOINT, 257), + + /* password for the SSL private key for proxy */ + CURLOPT(CURLOPT_PROXY_KEYPASSWD, CURLOPTTYPE_STRINGPOINT, 258), + + /* Specify which TLS 1.2 (1.1, 1.0) ciphers to use for proxy */ + CURLOPT(CURLOPT_PROXY_SSL_CIPHER_LIST, CURLOPTTYPE_STRINGPOINT, 259), + + /* CRL file for proxy */ + CURLOPT(CURLOPT_PROXY_CRLFILE, CURLOPTTYPE_STRINGPOINT, 260), + + /* Enable/disable specific SSL features with a bitmask for proxy, see + CURLSSLOPT_* */ + CURLOPT(CURLOPT_PROXY_SSL_OPTIONS, CURLOPTTYPE_LONG, 261), + + /* Name of pre proxy to use. */ + CURLOPT(CURLOPT_PRE_PROXY, CURLOPTTYPE_STRINGPOINT, 262), + + /* The public key in DER form used to validate the proxy public key + this option is used only if PROXY_SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_PROXY_PINNEDPUBLICKEY, CURLOPTTYPE_STRINGPOINT, 263), + + /* Path to an abstract Unix domain socket */ + CURLOPT(CURLOPT_ABSTRACT_UNIX_SOCKET, CURLOPTTYPE_STRINGPOINT, 264), + + /* Suppress proxy CONNECT response headers from user callbacks */ + CURLOPT(CURLOPT_SUPPRESS_CONNECT_HEADERS, CURLOPTTYPE_LONG, 265), + + /* The request target, instead of extracted from the URL */ + CURLOPT(CURLOPT_REQUEST_TARGET, CURLOPTTYPE_STRINGPOINT, 266), + + /* bitmask of allowed auth methods for connections to SOCKS5 proxies */ + CURLOPT(CURLOPT_SOCKS5_AUTH, CURLOPTTYPE_LONG, 267), + + /* Enable/disable SSH compression */ + CURLOPT(CURLOPT_SSH_COMPRESSION, CURLOPTTYPE_LONG, 268), + + /* Post MIME data. */ + CURLOPT(CURLOPT_MIMEPOST, CURLOPTTYPE_OBJECTPOINT, 269), + + /* Time to use with the CURLOPT_TIMECONDITION. Specified in number of + seconds since 1 Jan 1970. */ + CURLOPT(CURLOPT_TIMEVALUE_LARGE, CURLOPTTYPE_OFF_T, 270), + + /* Head start in milliseconds to give happy eyeballs. */ + CURLOPT(CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, CURLOPTTYPE_LONG, 271), + + /* Function that will be called before a resolver request is made */ + CURLOPT(CURLOPT_RESOLVER_START_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 272), + + /* User data to pass to the resolver start callback. */ + CURLOPT(CURLOPT_RESOLVER_START_DATA, CURLOPTTYPE_CBPOINT, 273), + + /* send HAProxy PROXY protocol header? */ + CURLOPT(CURLOPT_HAPROXYPROTOCOL, CURLOPTTYPE_LONG, 274), + + /* shuffle addresses before use when DNS returns multiple */ + CURLOPT(CURLOPT_DNS_SHUFFLE_ADDRESSES, CURLOPTTYPE_LONG, 275), + + /* Specify which TLS 1.3 ciphers suites to use */ + CURLOPT(CURLOPT_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 276), + CURLOPT(CURLOPT_PROXY_TLS13_CIPHERS, CURLOPTTYPE_STRINGPOINT, 277), + + /* Disallow specifying username/login in URL. */ + CURLOPT(CURLOPT_DISALLOW_USERNAME_IN_URL, CURLOPTTYPE_LONG, 278), + + /* DNS-over-HTTPS URL */ + CURLOPT(CURLOPT_DOH_URL, CURLOPTTYPE_STRINGPOINT, 279), + + /* Preferred buffer size to use for uploads */ + CURLOPT(CURLOPT_UPLOAD_BUFFERSIZE, CURLOPTTYPE_LONG, 280), + + /* Time in ms between connection upkeep calls for long-lived connections. */ + CURLOPT(CURLOPT_UPKEEP_INTERVAL_MS, CURLOPTTYPE_LONG, 281), + + /* Specify URL using CURL URL API. */ + CURLOPT(CURLOPT_CURLU, CURLOPTTYPE_OBJECTPOINT, 282), + + /* add trailing data just after no more data is available */ + CURLOPT(CURLOPT_TRAILERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 283), + + /* pointer to be passed to HTTP_TRAILER_FUNCTION */ + CURLOPT(CURLOPT_TRAILERDATA, CURLOPTTYPE_CBPOINT, 284), + + /* set this to 1L to allow HTTP/0.9 responses or 0L to disallow */ + CURLOPT(CURLOPT_HTTP09_ALLOWED, CURLOPTTYPE_LONG, 285), + + /* alt-svc control bitmask */ + CURLOPT(CURLOPT_ALTSVC_CTRL, CURLOPTTYPE_LONG, 286), + + /* alt-svc cache filename to possibly read from/write to */ + CURLOPT(CURLOPT_ALTSVC, CURLOPTTYPE_STRINGPOINT, 287), + + /* maximum age (idle time) of a connection to consider it for reuse + * (in seconds) */ + CURLOPT(CURLOPT_MAXAGE_CONN, CURLOPTTYPE_LONG, 288), + + /* SASL authorization identity */ + CURLOPT(CURLOPT_SASL_AUTHZID, CURLOPTTYPE_STRINGPOINT, 289), + + /* allow RCPT TO command to fail for some recipients */ + CURLOPT(CURLOPT_MAIL_RCPT_ALLOWFAILS, CURLOPTTYPE_LONG, 290), + + /* the private SSL-certificate as a "blob" */ + CURLOPT(CURLOPT_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 291), + CURLOPT(CURLOPT_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 292), + CURLOPT(CURLOPT_PROXY_SSLCERT_BLOB, CURLOPTTYPE_BLOB, 293), + CURLOPT(CURLOPT_PROXY_SSLKEY_BLOB, CURLOPTTYPE_BLOB, 294), + CURLOPT(CURLOPT_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 295), + + /* Issuer certificate for proxy */ + CURLOPT(CURLOPT_PROXY_ISSUERCERT, CURLOPTTYPE_STRINGPOINT, 296), + CURLOPT(CURLOPT_PROXY_ISSUERCERT_BLOB, CURLOPTTYPE_BLOB, 297), + + /* the EC curves requested by the TLS client (RFC 8422, 5.1); + * OpenSSL support via 'set_groups'/'set_curves': + * https://docs.openssl.org/master/man3/SSL_CTX_set1_curves/ + */ + CURLOPT(CURLOPT_SSL_EC_CURVES, CURLOPTTYPE_STRINGPOINT, 298), + + /* HSTS bitmask */ + CURLOPT(CURLOPT_HSTS_CTRL, CURLOPTTYPE_LONG, 299), + /* HSTS filename */ + CURLOPT(CURLOPT_HSTS, CURLOPTTYPE_STRINGPOINT, 300), + + /* HSTS read callback */ + CURLOPT(CURLOPT_HSTSREADFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 301), + CURLOPT(CURLOPT_HSTSREADDATA, CURLOPTTYPE_CBPOINT, 302), + + /* HSTS write callback */ + CURLOPT(CURLOPT_HSTSWRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 303), + CURLOPT(CURLOPT_HSTSWRITEDATA, CURLOPTTYPE_CBPOINT, 304), + + /* Parameters for V4 signature */ + CURLOPT(CURLOPT_AWS_SIGV4, CURLOPTTYPE_STRINGPOINT, 305), + + /* Same as CURLOPT_SSL_VERIFYPEER but for DoH (DNS-over-HTTPS) servers. */ + CURLOPT(CURLOPT_DOH_SSL_VERIFYPEER, CURLOPTTYPE_LONG, 306), + + /* Same as CURLOPT_SSL_VERIFYHOST but for DoH (DNS-over-HTTPS) servers. */ + CURLOPT(CURLOPT_DOH_SSL_VERIFYHOST, CURLOPTTYPE_LONG, 307), + + /* Same as CURLOPT_SSL_VERIFYSTATUS but for DoH (DNS-over-HTTPS) servers. */ + CURLOPT(CURLOPT_DOH_SSL_VERIFYSTATUS, CURLOPTTYPE_LONG, 308), + + /* The CA certificates as "blob" used to validate the peer certificate + this option is used only if SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_CAINFO_BLOB, CURLOPTTYPE_BLOB, 309), + + /* The CA certificates as "blob" used to validate the proxy certificate + this option is used only if PROXY_SSL_VERIFYPEER is true */ + CURLOPT(CURLOPT_PROXY_CAINFO_BLOB, CURLOPTTYPE_BLOB, 310), + + /* used by scp/sftp to verify the host's public key */ + CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256, CURLOPTTYPE_STRINGPOINT, 311), + + /* Function that will be called immediately before the initial request + is made on a connection (after any protocol negotiation step). */ + CURLOPT(CURLOPT_PREREQFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 312), + + /* Data passed to the CURLOPT_PREREQFUNCTION callback */ + CURLOPT(CURLOPT_PREREQDATA, CURLOPTTYPE_CBPOINT, 313), + + /* maximum age (since creation) of a connection to consider it for reuse + * (in seconds) */ + CURLOPT(CURLOPT_MAXLIFETIME_CONN, CURLOPTTYPE_LONG, 314), + + /* Set MIME option flags. */ + CURLOPT(CURLOPT_MIME_OPTIONS, CURLOPTTYPE_LONG, 315), + + /* set the SSH host key callback, must point to a curl_sshkeycallback + function */ + CURLOPT(CURLOPT_SSH_HOSTKEYFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 316), + + /* set the SSH host key callback custom pointer */ + CURLOPT(CURLOPT_SSH_HOSTKEYDATA, CURLOPTTYPE_CBPOINT, 317), + + /* specify which protocols that are allowed to be used for the transfer, + which thus helps the app which takes URLs from users or other external + inputs and want to restrict what protocol(s) to deal with. Defaults to + all built-in protocols. */ + CURLOPT(CURLOPT_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 318), + + /* specify which protocols that libcurl is allowed to follow directs to */ + CURLOPT(CURLOPT_REDIR_PROTOCOLS_STR, CURLOPTTYPE_STRINGPOINT, 319), + + /* WebSockets options */ + CURLOPT(CURLOPT_WS_OPTIONS, CURLOPTTYPE_LONG, 320), + + /* CA cache timeout */ + CURLOPT(CURLOPT_CA_CACHE_TIMEOUT, CURLOPTTYPE_LONG, 321), + + /* Can leak things, gonna exit() soon */ + CURLOPT(CURLOPT_QUICK_EXIT, CURLOPTTYPE_LONG, 322), + + /* set a specific client IP for HAProxy PROXY protocol header? */ + CURLOPT(CURLOPT_HAPROXY_CLIENT_IP, CURLOPTTYPE_STRINGPOINT, 323), + + /* millisecond version */ + CURLOPT(CURLOPT_SERVER_RESPONSE_TIMEOUT_MS, CURLOPTTYPE_LONG, 324), + + /* set ECH configuration */ + CURLOPT(CURLOPT_ECH, CURLOPTTYPE_STRINGPOINT, 325), + + /* maximum number of keepalive probes (Linux, *BSD, macOS, etc.) */ + CURLOPT(CURLOPT_TCP_KEEPCNT, CURLOPTTYPE_LONG, 326), + + CURLOPT(CURLOPT_UPLOAD_FLAGS, CURLOPTTYPE_LONG, 327), + + /* set TLS supported signature algorithms */ + CURLOPT(CURLOPT_SSL_SIGNATURE_ALGORITHMS, CURLOPTTYPE_STRINGPOINT, 328), + + CURLOPT_LASTENTRY /* the last unused */ +} CURLoption; + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* Backwards compatibility with older names */ +/* These are scheduled to disappear by 2011 */ + +/* This was added in version 7.19.1 */ +#define CURLOPT_POST301 CURLOPT_POSTREDIR + +/* These are scheduled to disappear by 2009 */ + +/* The following were added in 7.17.0 */ +#define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD +#define CURLOPT_FTPAPPEND CURLOPT_APPEND +#define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY +#define CURLOPT_FTP_SSL CURLOPT_USE_SSL + +/* The following were added earlier */ + +#define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD +#define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL + +/* */ +#define CURLOPT_FTP_RESPONSE_TIMEOUT CURLOPT_SERVER_RESPONSE_TIMEOUT + +/* Added in 8.2.0 */ +#define CURLOPT_MAIL_RCPT_ALLLOWFAILS CURLOPT_MAIL_RCPT_ALLOWFAILS + +#else +/* This is set if CURL_NO_OLDIES is defined at compile-time */ +#undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */ +#endif + + + /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host + name resolves addresses using more than one IP protocol version, this + option might be handy to force libcurl to use a specific IP version. */ +#define CURL_IPRESOLVE_WHATEVER 0L /* default, uses addresses to all IP + versions that your system allows */ +#define CURL_IPRESOLVE_V4 1L /* uses only IPv4 addresses/connections */ +#define CURL_IPRESOLVE_V6 2L /* uses only IPv6 addresses/connections */ + + /* Convenient "aliases" */ +#define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER + +/* These constants are for use with the CURLOPT_HTTP_VERSION option. */ +#define CURL_HTTP_VERSION_NONE 0L /* setting this means we do not care, and + that we would like the library to choose + the best possible for us! */ +#define CURL_HTTP_VERSION_1_0 1L /* please use HTTP 1.0 in the request */ +#define CURL_HTTP_VERSION_1_1 2L /* please use HTTP 1.1 in the request */ +#define CURL_HTTP_VERSION_2_0 3L /* please use HTTP 2 in the request */ +#define CURL_HTTP_VERSION_2TLS 4L /* use version 2 for HTTPS, version 1.1 for + HTTP */ +#define CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE 5L /* please use HTTP 2 without + HTTP/1.1 Upgrade */ +#define CURL_HTTP_VERSION_3 30L /* Use HTTP/3, fallback to HTTP/2 or + HTTP/1 if needed. For HTTPS only. For + HTTP, this option makes libcurl + return error. */ +#define CURL_HTTP_VERSION_3ONLY 31L /* Use HTTP/3 without fallback. For + HTTPS only. For HTTP, this makes + libcurl return error. */ +#define CURL_HTTP_VERSION_LAST 32L /* *ILLEGAL* http version */ + +/* Convenience definition simple because the name of the version is HTTP/2 and + not 2.0. The 2_0 version of the enum name was set while the version was + still planned to be 2.0 and we stick to it for compatibility. */ +#define CURL_HTTP_VERSION_2 CURL_HTTP_VERSION_2_0 + +/* + * Public API enums for RTSP requests + */ + +#define CURL_RTSPREQ_NONE 0L +#define CURL_RTSPREQ_OPTIONS 1L +#define CURL_RTSPREQ_DESCRIBE 2L +#define CURL_RTSPREQ_ANNOUNCE 3L +#define CURL_RTSPREQ_SETUP 4L +#define CURL_RTSPREQ_PLAY 5L +#define CURL_RTSPREQ_PAUSE 6L +#define CURL_RTSPREQ_TEARDOWN 7L +#define CURL_RTSPREQ_GET_PARAMETER 8L +#define CURL_RTSPREQ_SET_PARAMETER 9L +#define CURL_RTSPREQ_RECORD 10L +#define CURL_RTSPREQ_RECEIVE 11L +#define CURL_RTSPREQ_LAST 12L /* not used */ + + /* These enums are for use with the CURLOPT_NETRC option. */ +#define CURL_NETRC_IGNORED 0L /* The .netrc will never be read. + This is the default. */ +#define CURL_NETRC_OPTIONAL 1L /* A user:password in the URL will be preferred + to one in the .netrc. */ +#define CURL_NETRC_REQUIRED 2L /* A user:password in the URL will be ignored. + Unless one is set programmatically, the + .netrc will be queried. */ +enum CURL_NETRC_OPTION { + /* we set a single member here, just to make sure we still provide the enum, + but the values to use are defined above with L suffixes */ + CURL_NETRC_LAST = 3 +}; + +#define CURL_SSLVERSION_DEFAULT 0 +#define CURL_SSLVERSION_TLSv1 1 /* TLS 1.x */ +#define CURL_SSLVERSION_SSLv2 2 +#define CURL_SSLVERSION_SSLv3 3 +#define CURL_SSLVERSION_TLSv1_0 4 +#define CURL_SSLVERSION_TLSv1_1 5 +#define CURL_SSLVERSION_TLSv1_2 6 +#define CURL_SSLVERSION_TLSv1_3 7 + +#define CURL_SSLVERSION_LAST 8 /* never use, keep last */ + +#define CURL_SSLVERSION_MAX_NONE 0 +#define CURL_SSLVERSION_MAX_DEFAULT (CURL_SSLVERSION_TLSv1 << 16) +#define CURL_SSLVERSION_MAX_TLSv1_0 (CURL_SSLVERSION_TLSv1_0 << 16) +#define CURL_SSLVERSION_MAX_TLSv1_1 (CURL_SSLVERSION_TLSv1_1 << 16) +#define CURL_SSLVERSION_MAX_TLSv1_2 (CURL_SSLVERSION_TLSv1_2 << 16) +#define CURL_SSLVERSION_MAX_TLSv1_3 (CURL_SSLVERSION_TLSv1_3 << 16) + + /* never use, keep last */ +#define CURL_SSLVERSION_MAX_LAST (CURL_SSLVERSION_LAST << 16) + +#define CURL_TLSAUTH_NONE 0L +#define CURL_TLSAUTH_SRP 1L + +enum CURL_TLSAUTH { + /* we set a single member here, just to make sure we still provide the enum, + but the values to use are defined above with L suffixes */ + CURL_TLSAUTH_LAST = 2 +}; + +/* symbols to use with CURLOPT_POSTREDIR. + CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303 + can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302 + | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */ + +#define CURL_REDIR_GET_ALL 0 +#define CURL_REDIR_POST_301 1 +#define CURL_REDIR_POST_302 2 +#define CURL_REDIR_POST_303 4 +#define CURL_REDIR_POST_ALL \ + (CURL_REDIR_POST_301|CURL_REDIR_POST_302|CURL_REDIR_POST_303) + +#define CURL_TIMECOND_NONE 0L +#define CURL_TIMECOND_IFMODSINCE 1L +#define CURL_TIMECOND_IFUNMODSINCE 2L +#define CURL_TIMECOND_LASTMOD 3L + +typedef enum { + /* we set a single member here, just to make sure we still provide + the enum typedef, but the values to use are defined above with L + suffixes */ + CURL_TIMECOND_LAST = 4 +} curl_TimeCond; + +/* Special size_t value signaling a null-terminated string. */ +#define CURL_ZERO_TERMINATED ((size_t) -1) + +/* curl_strequal() and curl_strnequal() are subject for removal in a future + release */ +CURL_EXTERN int curl_strequal(const char *s1, const char *s2); +CURL_EXTERN int curl_strnequal(const char *s1, const char *s2, size_t n); + +/* Mime/form handling support. */ +typedef struct curl_mime curl_mime; /* Mime context. */ +typedef struct curl_mimepart curl_mimepart; /* Mime part context. */ + +/* CURLMIMEOPT_ defines are for the CURLOPT_MIME_OPTIONS option. */ +#define CURLMIMEOPT_FORMESCAPE (1<<0) /* Use backslash-escaping for forms. */ + +/* + * NAME curl_mime_init() + * + * DESCRIPTION + * + * Create a mime context and return its handle. The easy parameter is the + * target handle. + */ +CURL_EXTERN curl_mime *curl_mime_init(CURL *easy); + +/* + * NAME curl_mime_free() + * + * DESCRIPTION + * + * release a mime handle and its substructures. + */ +CURL_EXTERN void curl_mime_free(curl_mime *mime); + +/* + * NAME curl_mime_addpart() + * + * DESCRIPTION + * + * Append a new empty part to the given mime context and return a handle to + * the created part. + */ +CURL_EXTERN curl_mimepart *curl_mime_addpart(curl_mime *mime); + +/* + * NAME curl_mime_name() + * + * DESCRIPTION + * + * Set mime/form part name. + */ +CURL_EXTERN CURLcode curl_mime_name(curl_mimepart *part, const char *name); + +/* + * NAME curl_mime_filename() + * + * DESCRIPTION + * + * Set mime part remote filename. + */ +CURL_EXTERN CURLcode curl_mime_filename(curl_mimepart *part, + const char *filename); + +/* + * NAME curl_mime_type() + * + * DESCRIPTION + * + * Set mime part type. + */ +CURL_EXTERN CURLcode curl_mime_type(curl_mimepart *part, const char *mimetype); + +/* + * NAME curl_mime_encoder() + * + * DESCRIPTION + * + * Set mime data transfer encoder. + */ +CURL_EXTERN CURLcode curl_mime_encoder(curl_mimepart *part, + const char *encoding); + +/* + * NAME curl_mime_data() + * + * DESCRIPTION + * + * Set mime part data source from memory data, + */ +CURL_EXTERN CURLcode curl_mime_data(curl_mimepart *part, + const char *data, size_t datasize); + +/* + * NAME curl_mime_filedata() + * + * DESCRIPTION + * + * Set mime part data source from named file. + */ +CURL_EXTERN CURLcode curl_mime_filedata(curl_mimepart *part, + const char *filename); + +/* + * NAME curl_mime_data_cb() + * + * DESCRIPTION + * + * Set mime part data source from callback function. + */ +CURL_EXTERN CURLcode curl_mime_data_cb(curl_mimepart *part, + curl_off_t datasize, + curl_read_callback readfunc, + curl_seek_callback seekfunc, + curl_free_callback freefunc, + void *arg); + +/* + * NAME curl_mime_subparts() + * + * DESCRIPTION + * + * Set mime part data source from subparts. + */ +CURL_EXTERN CURLcode curl_mime_subparts(curl_mimepart *part, + curl_mime *subparts); +/* + * NAME curl_mime_headers() + * + * DESCRIPTION + * + * Set mime part headers. + */ +CURL_EXTERN CURLcode curl_mime_headers(curl_mimepart *part, + struct curl_slist *headers, + int take_ownership); + +typedef enum { + /********* the first one is unused ************/ + CURLFORM_NOTHING CURL_DEPRECATED(7.56.0, ""), + CURLFORM_COPYNAME CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"), + CURLFORM_PTRNAME CURL_DEPRECATED(7.56.0, "Use curl_mime_name()"), + CURLFORM_NAMELENGTH CURL_DEPRECATED(7.56.0, ""), + CURLFORM_COPYCONTENTS CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + CURLFORM_PTRCONTENTS CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + CURLFORM_CONTENTSLENGTH CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + CURLFORM_FILECONTENT CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"), + CURLFORM_ARRAY CURL_DEPRECATED(7.56.0, ""), + CURLFORM_OBSOLETE, + CURLFORM_FILE CURL_DEPRECATED(7.56.0, "Use curl_mime_filedata()"), + + CURLFORM_BUFFER CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"), + CURLFORM_BUFFERPTR CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + CURLFORM_BUFFERLENGTH CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + + CURLFORM_CONTENTTYPE CURL_DEPRECATED(7.56.0, "Use curl_mime_type()"), + CURLFORM_CONTENTHEADER CURL_DEPRECATED(7.56.0, "Use curl_mime_headers()"), + CURLFORM_FILENAME CURL_DEPRECATED(7.56.0, "Use curl_mime_filename()"), + CURLFORM_END, + CURLFORM_OBSOLETE2, + + CURLFORM_STREAM CURL_DEPRECATED(7.56.0, "Use curl_mime_data_cb()"), + CURLFORM_CONTENTLEN /* added in 7.46.0, provide a curl_off_t length */ + CURL_DEPRECATED(7.56.0, "Use curl_mime_data()"), + + CURLFORM_LASTENTRY /* the last unused */ +} CURLformoption; + +/* structure to be used as parameter for CURLFORM_ARRAY */ +struct curl_forms { + CURLformoption option; + const char *value; +}; + +/* use this for multipart formpost building */ +/* Returns code for curl_formadd() + * + * Returns: + * CURL_FORMADD_OK on success + * CURL_FORMADD_MEMORY if the FormInfo allocation fails + * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form + * CURL_FORMADD_NULL if a null pointer was given for a char + * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed + * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used + * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) + * CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated + * CURL_FORMADD_MEMORY if some allocation for string copying failed. + * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array + * + ***************************************************************************/ +typedef enum { + CURL_FORMADD_OK CURL_DEPRECATED(7.56.0, ""), /* 1st, no error */ + + CURL_FORMADD_MEMORY CURL_DEPRECATED(7.56.0, ""), + CURL_FORMADD_OPTION_TWICE CURL_DEPRECATED(7.56.0, ""), + CURL_FORMADD_NULL CURL_DEPRECATED(7.56.0, ""), + CURL_FORMADD_UNKNOWN_OPTION CURL_DEPRECATED(7.56.0, ""), + CURL_FORMADD_INCOMPLETE CURL_DEPRECATED(7.56.0, ""), + CURL_FORMADD_ILLEGAL_ARRAY CURL_DEPRECATED(7.56.0, ""), + /* libcurl was built with form api disabled */ + CURL_FORMADD_DISABLED CURL_DEPRECATED(7.56.0, ""), + + CURL_FORMADD_LAST /* last */ +} CURLFORMcode; + +/* + * NAME curl_formadd() + * + * DESCRIPTION + * + * Pretty advanced function for building multi-part formposts. Each invoke + * adds one part that together construct a full post. Then use + * CURLOPT_HTTPPOST to send it off to libcurl. + */ +CURL_EXTERN CURLFORMcode CURL_DEPRECATED(7.56.0, "Use curl_mime_init()") +curl_formadd(struct curl_httppost **httppost, + struct curl_httppost **last_post, + ...); + +/* + * callback function for curl_formget() + * The void *arg pointer will be the one passed as second argument to + * curl_formget(). + * The character buffer passed to it must not be freed. + * Should return the buffer length passed to it as the argument "len" on + * success. + */ +typedef size_t (*curl_formget_callback)(void *arg, const char *buf, + size_t len); + +/* + * NAME curl_formget() + * + * DESCRIPTION + * + * Serialize a curl_httppost struct built with curl_formadd(). + * Accepts a void pointer as second argument which will be passed to + * the curl_formget_callback function. + * Returns 0 on success. + */ +CURL_EXTERN int CURL_DEPRECATED(7.56.0, "") +curl_formget(struct curl_httppost *form, void *arg, + curl_formget_callback append); +/* + * NAME curl_formfree() + * + * DESCRIPTION + * + * Free a multipart formpost previously built with curl_formadd(). + */ +CURL_EXTERN void CURL_DEPRECATED(7.56.0, "Use curl_mime_free()") +curl_formfree(struct curl_httppost *form); + +/* + * NAME curl_getenv() + * + * DESCRIPTION + * + * Returns a malloc()'ed string that MUST be curl_free()ed after usage is + * complete. DEPRECATED - see lib/README.curlx + */ +CURL_EXTERN char *curl_getenv(const char *variable); + +/* + * NAME curl_version() + * + * DESCRIPTION + * + * Returns a static ASCII string of the libcurl version. + */ +CURL_EXTERN char *curl_version(void); + +/* + * NAME curl_easy_escape() + * + * DESCRIPTION + * + * Escapes URL strings (converts all letters consider illegal in URLs to their + * %XX versions). This function returns a new allocated string or NULL if an + * error occurred. + */ +CURL_EXTERN char *curl_easy_escape(CURL *handle, + const char *string, + int length); + +/* the previous version: */ +CURL_EXTERN char *curl_escape(const char *string, + int length); + + +/* + * NAME curl_easy_unescape() + * + * DESCRIPTION + * + * Unescapes URL encoding in strings (converts all %XX codes to their 8bit + * versions). This function returns a new allocated string or NULL if an error + * occurred. + * Conversion Note: On non-ASCII platforms the ASCII %XX codes are + * converted into the host encoding. + */ +CURL_EXTERN char *curl_easy_unescape(CURL *handle, + const char *string, + int length, + int *outlength); + +/* the previous version */ +CURL_EXTERN char *curl_unescape(const char *string, + int length); + +/* + * NAME curl_free() + * + * DESCRIPTION + * + * Provided for de-allocation in the same translation unit that did the + * allocation. Added in libcurl 7.10 + */ +CURL_EXTERN void curl_free(void *p); + +/* + * NAME curl_global_init() + * + * DESCRIPTION + * + * curl_global_init() should be invoked exactly once for each application that + * uses libcurl and before any call of other libcurl functions. + + * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the + * curl_version_info_data.features flag (fetch by curl_version_info()). + + */ +CURL_EXTERN CURLcode curl_global_init(long flags); + +/* + * NAME curl_global_init_mem() + * + * DESCRIPTION + * + * curl_global_init() or curl_global_init_mem() should be invoked exactly once + * for each application that uses libcurl. This function can be used to + * initialize libcurl and set user defined memory management callback + * functions. Users can implement memory management routines to check for + * memory leaks, check for mis-use of the curl library etc. User registered + * callback routines will be invoked by this library instead of the system + * memory management routines like malloc, free etc. + */ +CURL_EXTERN CURLcode curl_global_init_mem(long flags, + curl_malloc_callback m, + curl_free_callback f, + curl_realloc_callback r, + curl_strdup_callback s, + curl_calloc_callback c); + +/* + * NAME curl_global_cleanup() + * + * DESCRIPTION + * + * curl_global_cleanup() should be invoked exactly once for each application + * that uses libcurl + */ +CURL_EXTERN void curl_global_cleanup(void); + +/* + * NAME curl_global_trace() + * + * DESCRIPTION + * + * curl_global_trace() can be invoked at application start to + * configure which components in curl should participate in tracing. + + * This function is thread-safe if CURL_VERSION_THREADSAFE is set in the + * curl_version_info_data.features flag (fetch by curl_version_info()). + + */ +CURL_EXTERN CURLcode curl_global_trace(const char *config); + +/* linked-list structure for the CURLOPT_QUOTE option (and other) */ +struct curl_slist { + char *data; + struct curl_slist *next; +}; + +/* + * NAME curl_global_sslset() + * + * DESCRIPTION + * + * When built with multiple SSL backends, curl_global_sslset() allows to + * choose one. This function can only be called once, and it must be called + * *before* curl_global_init(). + * + * The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The + * backend can also be specified via the name parameter (passing -1 as id). If + * both id and name are specified, the name will be ignored. If neither id nor + * name are specified, the function will fail with CURLSSLSET_UNKNOWN_BACKEND + * and set the "avail" pointer to the NULL-terminated list of available + * backends. + * + * Upon success, the function returns CURLSSLSET_OK. + * + * If the specified SSL backend is not available, the function returns + * CURLSSLSET_UNKNOWN_BACKEND and sets the "avail" pointer to a + * NULL-terminated list of available SSL backends. + * + * The SSL backend can be set only once. If it has already been set, a + * subsequent attempt to change it will result in a CURLSSLSET_TOO_LATE. + */ + +struct curl_ssl_backend { + curl_sslbackend id; + const char *name; +}; +typedef struct curl_ssl_backend curl_ssl_backend; + +typedef enum { + CURLSSLSET_OK = 0, + CURLSSLSET_UNKNOWN_BACKEND, + CURLSSLSET_TOO_LATE, + CURLSSLSET_NO_BACKENDS /* libcurl was built without any SSL support */ +} CURLsslset; + +CURL_EXTERN CURLsslset curl_global_sslset(curl_sslbackend id, const char *name, + const curl_ssl_backend ***avail); + +/* + * NAME curl_slist_append() + * + * DESCRIPTION + * + * Appends a string to a linked list. If no list exists, it will be created + * first. Returns the new list, after appending. + */ +CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *list, + const char *data); + +/* + * NAME curl_slist_free_all() + * + * DESCRIPTION + * + * free a previously built curl_slist. + */ +CURL_EXTERN void curl_slist_free_all(struct curl_slist *list); + +/* + * NAME curl_getdate() + * + * DESCRIPTION + * + * Returns the time, in seconds since 1 Jan 1970 of the time string given in + * the first argument. The time argument in the second parameter is unused + * and should be set to NULL. + */ +CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused); + +/* info about the certificate chain, for SSL backends that support it. Asked + for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */ +struct curl_certinfo { + int num_of_certs; /* number of certificates with information */ + struct curl_slist **certinfo; /* for each index in this array, there is a + linked list with textual information for a + certificate in the format "name:content". + eg "Subject:foo", "Issuer:bar", etc. */ +}; + +/* Information about the SSL library used and the respective internal SSL + handle, which can be used to obtain further information regarding the + connection. Asked for with CURLINFO_TLS_SSL_PTR or CURLINFO_TLS_SESSION. */ +struct curl_tlssessioninfo { + curl_sslbackend backend; + void *internals; +}; + +#define CURLINFO_STRING 0x100000 +#define CURLINFO_LONG 0x200000 +#define CURLINFO_DOUBLE 0x300000 +#define CURLINFO_SLIST 0x400000 +#define CURLINFO_PTR 0x400000 /* same as SLIST */ +#define CURLINFO_SOCKET 0x500000 +#define CURLINFO_OFF_T 0x600000 +#define CURLINFO_MASK 0x0fffff +#define CURLINFO_TYPEMASK 0xf00000 + +typedef enum { + CURLINFO_NONE, /* first, never use this */ + CURLINFO_EFFECTIVE_URL = CURLINFO_STRING + 1, + CURLINFO_RESPONSE_CODE = CURLINFO_LONG + 2, + CURLINFO_TOTAL_TIME = CURLINFO_DOUBLE + 3, + CURLINFO_NAMELOOKUP_TIME = CURLINFO_DOUBLE + 4, + CURLINFO_CONNECT_TIME = CURLINFO_DOUBLE + 5, + CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6, + CURLINFO_SIZE_UPLOAD CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_UPLOAD_T") + = CURLINFO_DOUBLE + 7, + CURLINFO_SIZE_UPLOAD_T = CURLINFO_OFF_T + 7, + CURLINFO_SIZE_DOWNLOAD + CURL_DEPRECATED(7.55.0, "Use CURLINFO_SIZE_DOWNLOAD_T") + = CURLINFO_DOUBLE + 8, + CURLINFO_SIZE_DOWNLOAD_T = CURLINFO_OFF_T + 8, + CURLINFO_SPEED_DOWNLOAD + CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_DOWNLOAD_T") + = CURLINFO_DOUBLE + 9, + CURLINFO_SPEED_DOWNLOAD_T = CURLINFO_OFF_T + 9, + CURLINFO_SPEED_UPLOAD + CURL_DEPRECATED(7.55.0, "Use CURLINFO_SPEED_UPLOAD_T") + = CURLINFO_DOUBLE + 10, + CURLINFO_SPEED_UPLOAD_T = CURLINFO_OFF_T + 10, + CURLINFO_HEADER_SIZE = CURLINFO_LONG + 11, + CURLINFO_REQUEST_SIZE = CURLINFO_LONG + 12, + CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG + 13, + CURLINFO_FILETIME = CURLINFO_LONG + 14, + CURLINFO_FILETIME_T = CURLINFO_OFF_T + 14, + CURLINFO_CONTENT_LENGTH_DOWNLOAD + CURL_DEPRECATED(7.55.0, + "Use CURLINFO_CONTENT_LENGTH_DOWNLOAD_T") + = CURLINFO_DOUBLE + 15, + CURLINFO_CONTENT_LENGTH_DOWNLOAD_T = CURLINFO_OFF_T + 15, + CURLINFO_CONTENT_LENGTH_UPLOAD + CURL_DEPRECATED(7.55.0, + "Use CURLINFO_CONTENT_LENGTH_UPLOAD_T") + = CURLINFO_DOUBLE + 16, + CURLINFO_CONTENT_LENGTH_UPLOAD_T = CURLINFO_OFF_T + 16, + CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17, + CURLINFO_CONTENT_TYPE = CURLINFO_STRING + 18, + CURLINFO_REDIRECT_TIME = CURLINFO_DOUBLE + 19, + CURLINFO_REDIRECT_COUNT = CURLINFO_LONG + 20, + CURLINFO_PRIVATE = CURLINFO_STRING + 21, + CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG + 22, + CURLINFO_HTTPAUTH_AVAIL = CURLINFO_LONG + 23, + CURLINFO_PROXYAUTH_AVAIL = CURLINFO_LONG + 24, + CURLINFO_OS_ERRNO = CURLINFO_LONG + 25, + CURLINFO_NUM_CONNECTS = CURLINFO_LONG + 26, + CURLINFO_SSL_ENGINES = CURLINFO_SLIST + 27, + CURLINFO_COOKIELIST = CURLINFO_SLIST + 28, + CURLINFO_LASTSOCKET CURL_DEPRECATED(7.45.0, "Use CURLINFO_ACTIVESOCKET") + = CURLINFO_LONG + 29, + CURLINFO_FTP_ENTRY_PATH = CURLINFO_STRING + 30, + CURLINFO_REDIRECT_URL = CURLINFO_STRING + 31, + CURLINFO_PRIMARY_IP = CURLINFO_STRING + 32, + CURLINFO_APPCONNECT_TIME = CURLINFO_DOUBLE + 33, + CURLINFO_CERTINFO = CURLINFO_PTR + 34, + CURLINFO_CONDITION_UNMET = CURLINFO_LONG + 35, + CURLINFO_RTSP_SESSION_ID = CURLINFO_STRING + 36, + CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG + 37, + CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG + 38, + CURLINFO_RTSP_CSEQ_RECV = CURLINFO_LONG + 39, + CURLINFO_PRIMARY_PORT = CURLINFO_LONG + 40, + CURLINFO_LOCAL_IP = CURLINFO_STRING + 41, + CURLINFO_LOCAL_PORT = CURLINFO_LONG + 42, + CURLINFO_TLS_SESSION CURL_DEPRECATED(7.48.0, "Use CURLINFO_TLS_SSL_PTR") + = CURLINFO_PTR + 43, + CURLINFO_ACTIVESOCKET = CURLINFO_SOCKET + 44, + CURLINFO_TLS_SSL_PTR = CURLINFO_PTR + 45, + CURLINFO_HTTP_VERSION = CURLINFO_LONG + 46, + CURLINFO_PROXY_SSL_VERIFYRESULT = CURLINFO_LONG + 47, + CURLINFO_PROTOCOL CURL_DEPRECATED(7.85.0, "Use CURLINFO_SCHEME") + = CURLINFO_LONG + 48, + CURLINFO_SCHEME = CURLINFO_STRING + 49, + CURLINFO_TOTAL_TIME_T = CURLINFO_OFF_T + 50, + CURLINFO_NAMELOOKUP_TIME_T = CURLINFO_OFF_T + 51, + CURLINFO_CONNECT_TIME_T = CURLINFO_OFF_T + 52, + CURLINFO_PRETRANSFER_TIME_T = CURLINFO_OFF_T + 53, + CURLINFO_STARTTRANSFER_TIME_T = CURLINFO_OFF_T + 54, + CURLINFO_REDIRECT_TIME_T = CURLINFO_OFF_T + 55, + CURLINFO_APPCONNECT_TIME_T = CURLINFO_OFF_T + 56, + CURLINFO_RETRY_AFTER = CURLINFO_OFF_T + 57, + CURLINFO_EFFECTIVE_METHOD = CURLINFO_STRING + 58, + CURLINFO_PROXY_ERROR = CURLINFO_LONG + 59, + CURLINFO_REFERER = CURLINFO_STRING + 60, + CURLINFO_CAINFO = CURLINFO_STRING + 61, + CURLINFO_CAPATH = CURLINFO_STRING + 62, + CURLINFO_XFER_ID = CURLINFO_OFF_T + 63, + CURLINFO_CONN_ID = CURLINFO_OFF_T + 64, + CURLINFO_QUEUE_TIME_T = CURLINFO_OFF_T + 65, + CURLINFO_USED_PROXY = CURLINFO_LONG + 66, + CURLINFO_POSTTRANSFER_TIME_T = CURLINFO_OFF_T + 67, + CURLINFO_EARLYDATA_SENT_T = CURLINFO_OFF_T + 68, + CURLINFO_HTTPAUTH_USED = CURLINFO_LONG + 69, + CURLINFO_PROXYAUTH_USED = CURLINFO_LONG + 70, + CURLINFO_LASTONE = 70 +} CURLINFO; + +/* CURLINFO_RESPONSE_CODE is the new name for the option previously known as + CURLINFO_HTTP_CODE */ +#define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE + +typedef enum { + CURLCLOSEPOLICY_NONE, /* first, never use this */ + + CURLCLOSEPOLICY_OLDEST, + CURLCLOSEPOLICY_LEAST_RECENTLY_USED, + CURLCLOSEPOLICY_LEAST_TRAFFIC, + CURLCLOSEPOLICY_SLOWEST, + CURLCLOSEPOLICY_CALLBACK, + + CURLCLOSEPOLICY_LAST /* last, never use this */ +} curl_closepolicy; + +#define CURL_GLOBAL_SSL (1<<0) /* no purpose since 7.57.0 */ +#define CURL_GLOBAL_WIN32 (1<<1) +#define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32) +#define CURL_GLOBAL_NOTHING 0 +#define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL +#define CURL_GLOBAL_ACK_EINTR (1<<2) + + +/***************************************************************************** + * Setup defines, protos etc for the sharing stuff. + */ + +/* Different data locks for a single share */ +typedef enum { + CURL_LOCK_DATA_NONE = 0, + /* CURL_LOCK_DATA_SHARE is used internally to say that + * the locking is just made to change the internal state of the share + * itself. + */ + CURL_LOCK_DATA_SHARE, + CURL_LOCK_DATA_COOKIE, + CURL_LOCK_DATA_DNS, + CURL_LOCK_DATA_SSL_SESSION, + CURL_LOCK_DATA_CONNECT, + CURL_LOCK_DATA_PSL, + CURL_LOCK_DATA_HSTS, + CURL_LOCK_DATA_LAST +} curl_lock_data; + +/* Different lock access types */ +typedef enum { + CURL_LOCK_ACCESS_NONE = 0, /* unspecified action */ + CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */ + CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */ + CURL_LOCK_ACCESS_LAST /* never use */ +} curl_lock_access; + +typedef void (*curl_lock_function)(CURL *handle, + curl_lock_data data, + curl_lock_access locktype, + void *userptr); +typedef void (*curl_unlock_function)(CURL *handle, + curl_lock_data data, + void *userptr); + + +typedef enum { + CURLSHE_OK, /* all is fine */ + CURLSHE_BAD_OPTION, /* 1 */ + CURLSHE_IN_USE, /* 2 */ + CURLSHE_INVALID, /* 3 */ + CURLSHE_NOMEM, /* 4 out of memory */ + CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */ + CURLSHE_LAST /* never use */ +} CURLSHcode; + +typedef enum { + CURLSHOPT_NONE, /* do not use */ + CURLSHOPT_SHARE, /* specify a data type to share */ + CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */ + CURLSHOPT_LOCKFUNC, /* pass in a 'curl_lock_function' pointer */ + CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */ + CURLSHOPT_USERDATA, /* pass in a user data pointer used in the lock/unlock + callback functions */ + CURLSHOPT_LAST /* never use */ +} CURLSHoption; + +CURL_EXTERN CURLSH *curl_share_init(void); +CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *share, CURLSHoption option, + ...); +CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *share); + +/**************************************************************************** + * Structures for querying information about the curl library at runtime. + */ + +typedef enum { + CURLVERSION_FIRST, /* 7.10 */ + CURLVERSION_SECOND, /* 7.11.1 */ + CURLVERSION_THIRD, /* 7.12.0 */ + CURLVERSION_FOURTH, /* 7.16.1 */ + CURLVERSION_FIFTH, /* 7.57.0 */ + CURLVERSION_SIXTH, /* 7.66.0 */ + CURLVERSION_SEVENTH, /* 7.70.0 */ + CURLVERSION_EIGHTH, /* 7.72.0 */ + CURLVERSION_NINTH, /* 7.75.0 */ + CURLVERSION_TENTH, /* 7.77.0 */ + CURLVERSION_ELEVENTH, /* 7.87.0 */ + CURLVERSION_TWELFTH, /* 8.8.0 */ + CURLVERSION_LAST /* never actually use this */ +} CURLversion; + +/* The 'CURLVERSION_NOW' is the symbolic name meant to be used by + basically all programs ever that want to get version information. It is + meant to be a built-in version number for what kind of struct the caller + expects. If the struct ever changes, we redefine the NOW to another enum + from above. */ +#define CURLVERSION_NOW CURLVERSION_TWELFTH + +struct curl_version_info_data { + CURLversion age; /* age of the returned struct */ + const char *version; /* LIBCURL_VERSION */ + unsigned int version_num; /* LIBCURL_VERSION_NUM */ + const char *host; /* OS/host/cpu/machine when configured */ + int features; /* bitmask, see defines below */ + const char *ssl_version; /* human readable string */ + long ssl_version_num; /* not used anymore, always 0 */ + const char *libz_version; /* human readable string */ + /* protocols is terminated by an entry with a NULL protoname */ + const char * const *protocols; + + /* The fields below this were added in CURLVERSION_SECOND */ + const char *ares; + int ares_num; + + /* This field was added in CURLVERSION_THIRD */ + const char *libidn; + + /* These field were added in CURLVERSION_FOURTH */ + + /* Same as '_libiconv_version' if built with HAVE_ICONV */ + int iconv_ver_num; + + const char *libssh_version; /* human readable string */ + + /* These fields were added in CURLVERSION_FIFTH */ + unsigned int brotli_ver_num; /* Numeric Brotli version + (MAJOR << 24) | (MINOR << 12) | PATCH */ + const char *brotli_version; /* human readable string. */ + + /* These fields were added in CURLVERSION_SIXTH */ + unsigned int nghttp2_ver_num; /* Numeric nghttp2 version + (MAJOR << 16) | (MINOR << 8) | PATCH */ + const char *nghttp2_version; /* human readable string. */ + const char *quic_version; /* human readable quic (+ HTTP/3) library + + version or NULL */ + + /* These fields were added in CURLVERSION_SEVENTH */ + const char *cainfo; /* the built-in default CURLOPT_CAINFO, might + be NULL */ + const char *capath; /* the built-in default CURLOPT_CAPATH, might + be NULL */ + + /* These fields were added in CURLVERSION_EIGHTH */ + unsigned int zstd_ver_num; /* Numeric Zstd version + (MAJOR << 24) | (MINOR << 12) | PATCH */ + const char *zstd_version; /* human readable string. */ + + /* These fields were added in CURLVERSION_NINTH */ + const char *hyper_version; /* human readable string. */ + + /* These fields were added in CURLVERSION_TENTH */ + const char *gsasl_version; /* human readable string. */ + + /* These fields were added in CURLVERSION_ELEVENTH */ + /* feature_names is terminated by an entry with a NULL feature name */ + const char * const *feature_names; + + /* These fields were added in CURLVERSION_TWELFTH */ + const char *rtmp_version; /* human readable string. */ +}; +typedef struct curl_version_info_data curl_version_info_data; + +#define CURL_VERSION_IPV6 (1<<0) /* IPv6-enabled */ +#define CURL_VERSION_KERBEROS4 (1<<1) /* Kerberos V4 auth is supported + (deprecated) */ +#define CURL_VERSION_SSL (1<<2) /* SSL options are present */ +#define CURL_VERSION_LIBZ (1<<3) /* libz features are present */ +#define CURL_VERSION_NTLM (1<<4) /* NTLM auth is supported */ +#define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth is supported + (deprecated) */ +#define CURL_VERSION_DEBUG (1<<6) /* Built with debug capabilities */ +#define CURL_VERSION_ASYNCHDNS (1<<7) /* Asynchronous DNS resolves */ +#define CURL_VERSION_SPNEGO (1<<8) /* SPNEGO auth is supported */ +#define CURL_VERSION_LARGEFILE (1<<9) /* Supports files larger than 2GB */ +#define CURL_VERSION_IDN (1<<10) /* Internationized Domain Names are + supported */ +#define CURL_VERSION_SSPI (1<<11) /* Built against Windows SSPI */ +#define CURL_VERSION_CONV (1<<12) /* Character conversions supported */ +#define CURL_VERSION_CURLDEBUG (1<<13) /* Debug memory tracking supported */ +#define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */ +#define CURL_VERSION_NTLM_WB (1<<15) /* NTLM delegation to winbind helper + is supported */ +#define CURL_VERSION_HTTP2 (1<<16) /* HTTP2 support built-in */ +#define CURL_VERSION_GSSAPI (1<<17) /* Built against a GSS-API library */ +#define CURL_VERSION_KERBEROS5 (1<<18) /* Kerberos V5 auth is supported */ +#define CURL_VERSION_UNIX_SOCKETS (1<<19) /* Unix domain sockets support */ +#define CURL_VERSION_PSL (1<<20) /* Mozilla's Public Suffix List, used + for cookie domain verification */ +#define CURL_VERSION_HTTPS_PROXY (1<<21) /* HTTPS-proxy support built-in */ +#define CURL_VERSION_MULTI_SSL (1<<22) /* Multiple SSL backends available */ +#define CURL_VERSION_BROTLI (1<<23) /* Brotli features are present. */ +#define CURL_VERSION_ALTSVC (1<<24) /* Alt-Svc handling built-in */ +#define CURL_VERSION_HTTP3 (1<<25) /* HTTP3 support built-in */ +#define CURL_VERSION_ZSTD (1<<26) /* zstd features are present */ +#define CURL_VERSION_UNICODE (1<<27) /* Unicode support on Windows */ +#define CURL_VERSION_HSTS (1<<28) /* HSTS is supported */ +#define CURL_VERSION_GSASL (1<<29) /* libgsasl is supported */ +#define CURL_VERSION_THREADSAFE (1<<30) /* libcurl API is thread-safe */ + +/* + * NAME curl_version_info() + * + * DESCRIPTION + * + * This function returns a pointer to a static copy of the version info + * struct. See above. + */ +CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion); + +/* + * NAME curl_easy_strerror() + * + * DESCRIPTION + * + * The curl_easy_strerror function may be used to turn a CURLcode value + * into the equivalent human readable error string. This is useful + * for printing meaningful error messages. + */ +CURL_EXTERN const char *curl_easy_strerror(CURLcode); + +/* + * NAME curl_share_strerror() + * + * DESCRIPTION + * + * The curl_share_strerror function may be used to turn a CURLSHcode value + * into the equivalent human readable error string. This is useful + * for printing meaningful error messages. + */ +CURL_EXTERN const char *curl_share_strerror(CURLSHcode); + +/* + * NAME curl_easy_pause() + * + * DESCRIPTION + * + * The curl_easy_pause function pauses or unpauses transfers. Select the new + * state by setting the bitmask, use the convenience defines below. + * + */ +CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask); + +#define CURLPAUSE_RECV (1<<0) +#define CURLPAUSE_RECV_CONT (0) + +#define CURLPAUSE_SEND (1<<2) +#define CURLPAUSE_SEND_CONT (0) + +#define CURLPAUSE_ALL (CURLPAUSE_RECV|CURLPAUSE_SEND) +#define CURLPAUSE_CONT (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT) + +/* + * NAME curl_easy_ssls_import() + * + * DESCRIPTION + * + * The curl_easy_ssls_import function adds a previously exported SSL session + * to the SSL session cache of the easy handle (or the underlying share). + */ +CURL_EXTERN CURLcode curl_easy_ssls_import(CURL *handle, + const char *session_key, + const unsigned char *shmac, + size_t shmac_len, + const unsigned char *sdata, + size_t sdata_len); + +/* This is the curl_ssls_export_cb callback prototype. It + * is passed to curl_easy_ssls_export() to extract SSL sessions/tickets. */ +typedef CURLcode curl_ssls_export_cb(CURL *handle, + void *userptr, + const char *session_key, + const unsigned char *shmac, + size_t shmac_len, + const unsigned char *sdata, + size_t sdata_len, + curl_off_t valid_until, + int ietf_tls_id, + const char *alpn, + size_t earlydata_max); + +/* + * NAME curl_easy_ssls_export() + * + * DESCRIPTION + * + * The curl_easy_ssls_export function iterates over all SSL sessions stored + * in the easy handle (or underlying share) and invokes the passed + * callback. + * + */ +CURL_EXTERN CURLcode curl_easy_ssls_export(CURL *handle, + curl_ssls_export_cb *export_fn, + void *userptr); + + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +/* unfortunately, the easy.h and multi.h include files need options and info + stuff before they can be included! */ +#include "easy.h" /* nothing in curl is fun without the easy stuff */ +#include "multi.h" +#include "urlapi.h" +#include "options.h" +#include "header.h" +#include "websockets.h" +#include "mprintf.h" + +/* the typechecker does not work in C++ (yet) */ +#if defined(__GNUC__) && defined(__GNUC_MINOR__) && \ + ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \ + !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK) +#include "typecheck-gcc.h" +#else +#if defined(__STDC__) && (__STDC__ >= 1) +/* This preprocessor magic that replaces a call with the exact same call is + only done to make sure application authors pass exactly three arguments + to these functions. */ +#define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param) +#define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg) +#define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) +#define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) +#endif /* __STDC__ >= 1 */ +#endif /* gcc >= 4.3 && !__cplusplus && !CURL_DISABLE_TYPECHECK */ + +#endif /* CURLINC_CURL_H */ diff --git a/curl-install/include/curl/curlver.h b/curl-install/include/curl/curlver.h new file mode 100644 index 00000000..31b01b99 --- /dev/null +++ b/curl-install/include/curl/curlver.h @@ -0,0 +1,79 @@ +#ifndef CURLINC_CURLVER_H +#define CURLINC_CURLVER_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +/* This header file contains nothing but libcurl version info, generated by + a script at release-time. This was made its own header file in 7.11.2 */ + +/* This is the global package copyright */ +#define LIBCURL_COPYRIGHT "Daniel Stenberg, ." + +/* This is the version number of the libcurl package from which this header + file origins: */ +#define LIBCURL_VERSION "8.15.0" + +/* The numeric version number is also available "in parts" by using these + defines: */ +#define LIBCURL_VERSION_MAJOR 8 +#define LIBCURL_VERSION_MINOR 15 +#define LIBCURL_VERSION_PATCH 0 + +/* This is the numeric version of the libcurl version number, meant for easier + parsing and comparisons by programs. The LIBCURL_VERSION_NUM define will + always follow this syntax: + + 0xXXYYZZ + + Where XX, YY and ZZ are the main version, release and patch numbers in + hexadecimal (using 8 bits each). All three numbers are always represented + using two digits. 1.2 would appear as "0x010200" while version 9.11.7 + appears as "0x090b07". + + This 6-digit (24 bits) hexadecimal number does not show pre-release number, + and it is always a greater number in a more recent release. It makes + comparisons with greater than and less than work. + + Note: This define is the full hex number and _does not_ use the + CURL_VERSION_BITS() macro since curl's own configure script greps for it + and needs it to contain the full number. +*/ +#define LIBCURL_VERSION_NUM 0x080f00 + +/* + * This is the date and time when the full source package was created. The + * timestamp is not stored in git, as the timestamp is properly set in the + * tarballs by the maketgz script. + * + * The format of the date follows this template: + * + * "2007-11-23" + */ +#define LIBCURL_TIMESTAMP "2025-07-16" + +#define CURL_VERSION_BITS(x,y,z) ((x)<<16|(y)<<8|(z)) +#define CURL_AT_LEAST_VERSION(x,y,z) \ + (LIBCURL_VERSION_NUM >= CURL_VERSION_BITS(x, y, z)) + +#endif /* CURLINC_CURLVER_H */ diff --git a/curl-install/include/curl/easy.h b/curl-install/include/curl/easy.h new file mode 100644 index 00000000..56f8060e --- /dev/null +++ b/curl-install/include/curl/easy.h @@ -0,0 +1,125 @@ +#ifndef CURLINC_EASY_H +#define CURLINC_EASY_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ +#ifdef __cplusplus +extern "C" { +#endif + +/* Flag bits in the curl_blob struct: */ +#define CURL_BLOB_COPY 1 /* tell libcurl to copy the data */ +#define CURL_BLOB_NOCOPY 0 /* tell libcurl to NOT copy the data */ + +struct curl_blob { + void *data; + size_t len; + unsigned int flags; /* bit 0 is defined, the rest are reserved and should be + left zeroes */ +}; + +CURL_EXTERN CURL *curl_easy_init(void); +CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...); +CURL_EXTERN CURLcode curl_easy_perform(CURL *curl); +CURL_EXTERN void curl_easy_cleanup(CURL *curl); + +/* + * NAME curl_easy_getinfo() + * + * DESCRIPTION + * + * Request internal information from the curl session with this function. + * The third argument MUST be pointing to the specific type of the used option + * which is documented in each manpage of the option. The data pointed to + * will be filled in accordingly and can be relied upon only if the function + * returns CURLE_OK. This function is intended to get used *AFTER* a performed + * transfer, all results from this function are undefined until the transfer + * is completed. + */ +CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...); + + +/* + * NAME curl_easy_duphandle() + * + * DESCRIPTION + * + * Creates a new curl session handle with the same options set for the handle + * passed in. Duplicating a handle could only be a matter of cloning data and + * options, internal state info and things like persistent connections cannot + * be transferred. It is useful in multithreaded applications when you can run + * curl_easy_duphandle() for each new thread to avoid a series of identical + * curl_easy_setopt() invokes in every thread. + */ +CURL_EXTERN CURL *curl_easy_duphandle(CURL *curl); + +/* + * NAME curl_easy_reset() + * + * DESCRIPTION + * + * Re-initializes a curl handle to the default values. This puts back the + * handle to the same state as it was in when it was just created. + * + * It does keep: live connections, the Session ID cache, the DNS cache and the + * cookies. + */ +CURL_EXTERN void curl_easy_reset(CURL *curl); + +/* + * NAME curl_easy_recv() + * + * DESCRIPTION + * + * Receives data from the connected socket. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen, + size_t *n); + +/* + * NAME curl_easy_send() + * + * DESCRIPTION + * + * Sends data over the connected socket. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer, + size_t buflen, size_t *n); + + +/* + * NAME curl_easy_upkeep() + * + * DESCRIPTION + * + * Performs connection upkeep for the given session handle. + */ +CURL_EXTERN CURLcode curl_easy_upkeep(CURL *curl); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif diff --git a/curl-install/include/curl/header.h b/curl-install/include/curl/header.h new file mode 100644 index 00000000..8df11e1e --- /dev/null +++ b/curl-install/include/curl/header.h @@ -0,0 +1,74 @@ +#ifndef CURLINC_HEADER_H +#define CURLINC_HEADER_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#ifdef __cplusplus +extern "C" { +#endif + +struct curl_header { + char *name; /* this might not use the same case */ + char *value; + size_t amount; /* number of headers using this name */ + size_t index; /* ... of this instance, 0 or higher */ + unsigned int origin; /* see bits below */ + void *anchor; /* handle privately used by libcurl */ +}; + +/* 'origin' bits */ +#define CURLH_HEADER (1<<0) /* plain server header */ +#define CURLH_TRAILER (1<<1) /* trailers */ +#define CURLH_CONNECT (1<<2) /* CONNECT headers */ +#define CURLH_1XX (1<<3) /* 1xx headers */ +#define CURLH_PSEUDO (1<<4) /* pseudo headers */ + +typedef enum { + CURLHE_OK, + CURLHE_BADINDEX, /* header exists but not with this index */ + CURLHE_MISSING, /* no such header exists */ + CURLHE_NOHEADERS, /* no headers at all exist (yet) */ + CURLHE_NOREQUEST, /* no request with this number was used */ + CURLHE_OUT_OF_MEMORY, /* out of memory while processing */ + CURLHE_BAD_ARGUMENT, /* a function argument was not okay */ + CURLHE_NOT_BUILT_IN /* if API was disabled in the build */ +} CURLHcode; + +CURL_EXTERN CURLHcode curl_easy_header(CURL *easy, + const char *name, + size_t index, + unsigned int origin, + int request, + struct curl_header **hout); + +CURL_EXTERN struct curl_header *curl_easy_nextheader(CURL *easy, + unsigned int origin, + int request, + struct curl_header *prev); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif /* CURLINC_HEADER_H */ diff --git a/curl-install/include/curl/mprintf.h b/curl-install/include/curl/mprintf.h new file mode 100644 index 00000000..88059c85 --- /dev/null +++ b/curl-install/include/curl/mprintf.h @@ -0,0 +1,85 @@ +#ifndef CURLINC_MPRINTF_H +#define CURLINC_MPRINTF_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#include +#include /* needed for FILE */ +#include "curl.h" /* for CURL_EXTERN */ + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef CURL_TEMP_PRINTF +#if (defined(__GNUC__) || defined(__clang__) || \ + defined(__IAR_SYSTEMS_ICC__)) && \ + defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \ + !defined(CURL_NO_FMT_CHECKS) +#if defined(__MINGW32__) && !defined(__clang__) +#if defined(__MINGW_PRINTF_FORMAT) /* mingw-w64 3.0.0+. Needs stdio.h. */ +#define CURL_TEMP_PRINTF(fmt, arg) \ + __attribute__((format(__MINGW_PRINTF_FORMAT, fmt, arg))) +#else +#define CURL_TEMP_PRINTF(fmt, arg) +#endif +#else +#define CURL_TEMP_PRINTF(fmt, arg) \ + __attribute__((format(printf, fmt, arg))) +#endif +#else +#define CURL_TEMP_PRINTF(fmt, arg) +#endif +#endif + +CURL_EXTERN int curl_mprintf(const char *format, ...) + CURL_TEMP_PRINTF(1, 2); +CURL_EXTERN int curl_mfprintf(FILE *fd, const char *format, ...) + CURL_TEMP_PRINTF(2, 3); +CURL_EXTERN int curl_msprintf(char *buffer, const char *format, ...) + CURL_TEMP_PRINTF(2, 3); +CURL_EXTERN int curl_msnprintf(char *buffer, size_t maxlength, + const char *format, ...) + CURL_TEMP_PRINTF(3, 4); +CURL_EXTERN int curl_mvprintf(const char *format, va_list args) + CURL_TEMP_PRINTF(1, 0); +CURL_EXTERN int curl_mvfprintf(FILE *fd, const char *format, va_list args) + CURL_TEMP_PRINTF(2, 0); +CURL_EXTERN int curl_mvsprintf(char *buffer, const char *format, va_list args) + CURL_TEMP_PRINTF(2, 0); +CURL_EXTERN int curl_mvsnprintf(char *buffer, size_t maxlength, + const char *format, va_list args) + CURL_TEMP_PRINTF(3, 0); +CURL_EXTERN char *curl_maprintf(const char *format, ...) + CURL_TEMP_PRINTF(1, 2); +CURL_EXTERN char *curl_mvaprintf(const char *format, va_list args) + CURL_TEMP_PRINTF(1, 0); + +#undef CURL_TEMP_PRINTF + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif /* CURLINC_MPRINTF_H */ diff --git a/curl-install/include/curl/multi.h b/curl-install/include/curl/multi.h new file mode 100644 index 00000000..42469bb5 --- /dev/null +++ b/curl-install/include/curl/multi.h @@ -0,0 +1,481 @@ +#ifndef CURLINC_MULTI_H +#define CURLINC_MULTI_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ +/* + This is an "external" header file. Do not give away any internals here! + + GOALS + + o Enable a "pull" interface. The application that uses libcurl decides where + and when to ask libcurl to get/send data. + + o Enable multiple simultaneous transfers in the same thread without making it + complicated for the application. + + o Enable the application to select() on its own file descriptors and curl's + file descriptors simultaneous easily. + +*/ + +/* + * This header file should not really need to include "curl.h" since curl.h + * itself includes this file and we expect user applications to do #include + * without the need for especially including multi.h. + * + * For some reason we added this include here at one point, and rather than to + * break existing (wrongly written) libcurl applications, we leave it as-is + * but with this warning attached. + */ +#include "curl.h" + +#ifdef __cplusplus +extern "C" { +#endif + +typedef void CURLM; + +typedef enum { + CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or + curl_multi_socket*() soon */ + CURLM_OK, + CURLM_BAD_HANDLE, /* the passed-in handle is not a valid CURLM handle */ + CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */ + CURLM_OUT_OF_MEMORY, /* if you ever get this, you are in deep sh*t */ + CURLM_INTERNAL_ERROR, /* this is a libcurl bug */ + CURLM_BAD_SOCKET, /* the passed in socket argument did not match */ + CURLM_UNKNOWN_OPTION, /* curl_multi_setopt() with unsupported option */ + CURLM_ADDED_ALREADY, /* an easy handle already added to a multi handle was + attempted to get added - again */ + CURLM_RECURSIVE_API_CALL, /* an api function was called from inside a + callback */ + CURLM_WAKEUP_FAILURE, /* wakeup is unavailable or failed */ + CURLM_BAD_FUNCTION_ARGUMENT, /* function called with a bad parameter */ + CURLM_ABORTED_BY_CALLBACK, + CURLM_UNRECOVERABLE_POLL, + CURLM_LAST +} CURLMcode; + +/* just to make code nicer when using curl_multi_socket() you can now check + for CURLM_CALL_MULTI_SOCKET too in the same style it works for + curl_multi_perform() and CURLM_CALL_MULTI_PERFORM */ +#define CURLM_CALL_MULTI_SOCKET CURLM_CALL_MULTI_PERFORM + +/* bitmask bits for CURLMOPT_PIPELINING */ +#define CURLPIPE_NOTHING 0L +#define CURLPIPE_HTTP1 1L +#define CURLPIPE_MULTIPLEX 2L + +typedef enum { + CURLMSG_NONE, /* first, not used */ + CURLMSG_DONE, /* This easy handle has completed. 'result' contains + the CURLcode of the transfer */ + CURLMSG_LAST /* last, not used */ +} CURLMSG; + +struct CURLMsg { + CURLMSG msg; /* what this message means */ + CURL *easy_handle; /* the handle it concerns */ + union { + void *whatever; /* message-specific data */ + CURLcode result; /* return code for transfer */ + } data; +}; +typedef struct CURLMsg CURLMsg; + +/* Based on poll(2) structure and values. + * We do not use pollfd and POLL* constants explicitly + * to cover platforms without poll(). */ +#define CURL_WAIT_POLLIN 0x0001 +#define CURL_WAIT_POLLPRI 0x0002 +#define CURL_WAIT_POLLOUT 0x0004 + +struct curl_waitfd { + curl_socket_t fd; + short events; + short revents; +}; + +/* + * Name: curl_multi_init() + * + * Desc: initialize multi-style curl usage + * + * Returns: a new CURLM handle to use in all 'curl_multi' functions. + */ +CURL_EXTERN CURLM *curl_multi_init(void); + +/* + * Name: curl_multi_add_handle() + * + * Desc: add a standard curl handle to the multi stack + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_add_handle(CURLM *multi_handle, + CURL *curl_handle); + + /* + * Name: curl_multi_remove_handle() + * + * Desc: removes a curl handle from the multi stack again + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_remove_handle(CURLM *multi_handle, + CURL *curl_handle); + + /* + * Name: curl_multi_fdset() + * + * Desc: Ask curl for its fd_set sets. The app can use these to select() or + * poll() on. We want curl_multi_perform() called as soon as one of + * them are ready. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_fdset(CURLM *multi_handle, + fd_set *read_fd_set, + fd_set *write_fd_set, + fd_set *exc_fd_set, + int *max_fd); + +/* + * Name: curl_multi_wait() + * + * Desc: Poll on all fds within a CURLM set as well as any + * additional fds passed to the function. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_wait(CURLM *multi_handle, + struct curl_waitfd extra_fds[], + unsigned int extra_nfds, + int timeout_ms, + int *ret); + +/* + * Name: curl_multi_poll() + * + * Desc: Poll on all fds within a CURLM set as well as any + * additional fds passed to the function. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_poll(CURLM *multi_handle, + struct curl_waitfd extra_fds[], + unsigned int extra_nfds, + int timeout_ms, + int *ret); + +/* + * Name: curl_multi_wakeup() + * + * Desc: wakes up a sleeping curl_multi_poll call. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_wakeup(CURLM *multi_handle); + + /* + * Name: curl_multi_perform() + * + * Desc: When the app thinks there is data available for curl it calls this + * function to read/write whatever there is right now. This returns + * as soon as the reads and writes are done. This function does not + * require that there actually is data available for reading or that + * data can be written, it can be called just in case. It returns + * the number of handles that still transfer data in the second + * argument's integer-pointer. + * + * Returns: CURLMcode type, general multi error code. *NOTE* that this only + * returns errors etc regarding the whole multi stack. There might + * still have occurred problems on individual transfers even when + * this returns OK. + */ +CURL_EXTERN CURLMcode curl_multi_perform(CURLM *multi_handle, + int *running_handles); + + /* + * Name: curl_multi_cleanup() + * + * Desc: Cleans up and removes a whole multi stack. It does not free or + * touch any individual easy handles in any way. We need to define + * in what state those handles will be if this function is called + * in the middle of a transfer. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_cleanup(CURLM *multi_handle); + +/* + * Name: curl_multi_info_read() + * + * Desc: Ask the multi handle if there is any messages/informationals from + * the individual transfers. Messages include informationals such as + * error code from the transfer or just the fact that a transfer is + * completed. More details on these should be written down as well. + * + * Repeated calls to this function will return a new struct each + * time, until a special "end of msgs" struct is returned as a signal + * that there is no more to get at this point. + * + * The data the returned pointer points to will not survive calling + * curl_multi_cleanup(). + * + * The 'CURLMsg' struct is meant to be simple and only contain basic + * information. If more involved information is wanted, we will + * provide the particular "transfer handle" in that struct and that + * should/could/would be used in subsequent curl_easy_getinfo() calls + * (or similar). The point being that we must never expose complex + * structs to applications, as then we will undoubtably get backwards + * compatibility problems in the future. + * + * Returns: A pointer to a filled-in struct, or NULL if it failed or ran out + * of structs. It also writes the number of messages left in the + * queue (after this read) in the integer the second argument points + * to. + */ +CURL_EXTERN CURLMsg *curl_multi_info_read(CURLM *multi_handle, + int *msgs_in_queue); + +/* + * Name: curl_multi_strerror() + * + * Desc: The curl_multi_strerror function may be used to turn a CURLMcode + * value into the equivalent human readable error string. This is + * useful for printing meaningful error messages. + * + * Returns: A pointer to a null-terminated error message. + */ +CURL_EXTERN const char *curl_multi_strerror(CURLMcode); + +/* + * Name: curl_multi_socket() and + * curl_multi_socket_all() + * + * Desc: An alternative version of curl_multi_perform() that allows the + * application to pass in one of the file descriptors that have been + * detected to have "action" on them and let libcurl perform. + * See manpage for details. + */ +#define CURL_POLL_NONE 0 +#define CURL_POLL_IN 1 +#define CURL_POLL_OUT 2 +#define CURL_POLL_INOUT 3 +#define CURL_POLL_REMOVE 4 + +#define CURL_SOCKET_TIMEOUT CURL_SOCKET_BAD + +#define CURL_CSELECT_IN 0x01 +#define CURL_CSELECT_OUT 0x02 +#define CURL_CSELECT_ERR 0x04 + +typedef int (*curl_socket_callback)(CURL *easy, /* easy handle */ + curl_socket_t s, /* socket */ + int what, /* see above */ + void *userp, /* private callback + pointer */ + void *socketp); /* private socket + pointer */ +/* + * Name: curl_multi_timer_callback + * + * Desc: Called by libcurl whenever the library detects a change in the + * maximum number of milliseconds the app is allowed to wait before + * curl_multi_socket() or curl_multi_perform() must be called + * (to allow libcurl's timed events to take place). + * + * Returns: The callback should return zero. + */ +typedef int (*curl_multi_timer_callback)(CURLM *multi, /* multi handle */ + long timeout_ms, /* see above */ + void *userp); /* private callback + pointer */ + +CURL_EXTERN CURLMcode CURL_DEPRECATED(7.19.5, "Use curl_multi_socket_action()") +curl_multi_socket(CURLM *multi_handle, curl_socket_t s, int *running_handles); + +CURL_EXTERN CURLMcode curl_multi_socket_action(CURLM *multi_handle, + curl_socket_t s, + int ev_bitmask, + int *running_handles); + +CURL_EXTERN CURLMcode CURL_DEPRECATED(7.19.5, "Use curl_multi_socket_action()") +curl_multi_socket_all(CURLM *multi_handle, int *running_handles); + +#ifndef CURL_ALLOW_OLD_MULTI_SOCKET +/* This macro below was added in 7.16.3 to push users who recompile to use + the new curl_multi_socket_action() instead of the old curl_multi_socket() +*/ +#define curl_multi_socket(x,y,z) curl_multi_socket_action(x,y,0,z) +#endif + +/* + * Name: curl_multi_timeout() + * + * Desc: Returns the maximum number of milliseconds the app is allowed to + * wait before curl_multi_socket() or curl_multi_perform() must be + * called (to allow libcurl's timed events to take place). + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_timeout(CURLM *multi_handle, + long *milliseconds); + +typedef enum { + /* This is the socket callback function pointer */ + CURLOPT(CURLMOPT_SOCKETFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 1), + + /* This is the argument passed to the socket callback */ + CURLOPT(CURLMOPT_SOCKETDATA, CURLOPTTYPE_OBJECTPOINT, 2), + + /* set to 1 to enable pipelining for this multi handle */ + CURLOPT(CURLMOPT_PIPELINING, CURLOPTTYPE_LONG, 3), + + /* This is the timer callback function pointer */ + CURLOPT(CURLMOPT_TIMERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 4), + + /* This is the argument passed to the timer callback */ + CURLOPT(CURLMOPT_TIMERDATA, CURLOPTTYPE_OBJECTPOINT, 5), + + /* maximum number of entries in the connection cache */ + CURLOPT(CURLMOPT_MAXCONNECTS, CURLOPTTYPE_LONG, 6), + + /* maximum number of (pipelining) connections to one host */ + CURLOPT(CURLMOPT_MAX_HOST_CONNECTIONS, CURLOPTTYPE_LONG, 7), + + /* maximum number of requests in a pipeline */ + CURLOPT(CURLMOPT_MAX_PIPELINE_LENGTH, CURLOPTTYPE_LONG, 8), + + /* a connection with a content-length longer than this + will not be considered for pipelining */ + CURLOPT(CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 9), + + /* a connection with a chunk length longer than this + will not be considered for pipelining */ + CURLOPT(CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 10), + + /* a list of site names(+port) that are blocked from pipelining */ + CURLOPT(CURLMOPT_PIPELINING_SITE_BL, CURLOPTTYPE_OBJECTPOINT, 11), + + /* a list of server types that are blocked from pipelining */ + CURLOPT(CURLMOPT_PIPELINING_SERVER_BL, CURLOPTTYPE_OBJECTPOINT, 12), + + /* maximum number of open connections in total */ + CURLOPT(CURLMOPT_MAX_TOTAL_CONNECTIONS, CURLOPTTYPE_LONG, 13), + + /* This is the server push callback function pointer */ + CURLOPT(CURLMOPT_PUSHFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 14), + + /* This is the argument passed to the server push callback */ + CURLOPT(CURLMOPT_PUSHDATA, CURLOPTTYPE_OBJECTPOINT, 15), + + /* maximum number of concurrent streams to support on a connection */ + CURLOPT(CURLMOPT_MAX_CONCURRENT_STREAMS, CURLOPTTYPE_LONG, 16), + + CURLMOPT_LASTENTRY /* the last unused */ +} CURLMoption; + + +/* + * Name: curl_multi_setopt() + * + * Desc: Sets options for the multi handle. + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_setopt(CURLM *multi_handle, + CURLMoption option, ...); + + +/* + * Name: curl_multi_assign() + * + * Desc: This function sets an association in the multi handle between the + * given socket and a private pointer of the application. This is + * (only) useful for curl_multi_socket uses. + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_assign(CURLM *multi_handle, + curl_socket_t sockfd, void *sockp); + +/* + * Name: curl_multi_get_handles() + * + * Desc: Returns an allocated array holding all handles currently added to + * the multi handle. Marks the final entry with a NULL pointer. If + * there is no easy handle added to the multi handle, this function + * returns an array with the first entry as a NULL pointer. + * + * Returns: NULL on failure, otherwise a CURL **array pointer + */ +CURL_EXTERN CURL **curl_multi_get_handles(CURLM *multi_handle); + +/* + * Name: curl_push_callback + * + * Desc: This callback gets called when a new stream is being pushed by the + * server. It approves or denies the new stream. It can also decide + * to completely fail the connection. + * + * Returns: CURL_PUSH_OK, CURL_PUSH_DENY or CURL_PUSH_ERROROUT + */ +#define CURL_PUSH_OK 0 +#define CURL_PUSH_DENY 1 +#define CURL_PUSH_ERROROUT 2 /* added in 7.72.0 */ + +struct curl_pushheaders; /* forward declaration only */ + +CURL_EXTERN char *curl_pushheader_bynum(struct curl_pushheaders *h, + size_t num); +CURL_EXTERN char *curl_pushheader_byname(struct curl_pushheaders *h, + const char *name); + +typedef int (*curl_push_callback)(CURL *parent, + CURL *easy, + size_t num_headers, + struct curl_pushheaders *headers, + void *userp); + +/* + * Name: curl_multi_waitfds() + * + * Desc: Ask curl for fds for polling. The app can use these to poll on. + * We want curl_multi_perform() called as soon as one of them are + * ready. Passing zero size allows to get just a number of fds. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_waitfds(CURLM *multi, + struct curl_waitfd *ufds, + unsigned int size, + unsigned int *fd_count); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif diff --git a/curl-install/include/curl/options.h b/curl-install/include/curl/options.h new file mode 100644 index 00000000..1ed76a95 --- /dev/null +++ b/curl-install/include/curl/options.h @@ -0,0 +1,70 @@ +#ifndef CURLINC_OPTIONS_H +#define CURLINC_OPTIONS_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#ifdef __cplusplus +extern "C" { +#endif + +typedef enum { + CURLOT_LONG, /* long (a range of values) */ + CURLOT_VALUES, /* (a defined set or bitmask) */ + CURLOT_OFF_T, /* curl_off_t (a range of values) */ + CURLOT_OBJECT, /* pointer (void *) */ + CURLOT_STRING, /* (char * to null-terminated buffer) */ + CURLOT_SLIST, /* (struct curl_slist *) */ + CURLOT_CBPTR, /* (void * passed as-is to a callback) */ + CURLOT_BLOB, /* blob (struct curl_blob *) */ + CURLOT_FUNCTION /* function pointer */ +} curl_easytype; + +/* Flag bits */ + +/* "alias" means it is provided for old programs to remain functional, + we prefer another name */ +#define CURLOT_FLAG_ALIAS (1<<0) + +/* The CURLOPTTYPE_* id ranges can still be used to figure out what type/size + to use for curl_easy_setopt() for the given id */ +struct curl_easyoption { + const char *name; + CURLoption id; + curl_easytype type; + unsigned int flags; +}; + +CURL_EXTERN const struct curl_easyoption * +curl_easy_option_by_name(const char *name); + +CURL_EXTERN const struct curl_easyoption * +curl_easy_option_by_id(CURLoption id); + +CURL_EXTERN const struct curl_easyoption * +curl_easy_option_next(const struct curl_easyoption *prev); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif +#endif /* CURLINC_OPTIONS_H */ diff --git a/curl-install/include/curl/stdcheaders.h b/curl-install/include/curl/stdcheaders.h new file mode 100644 index 00000000..7451aa30 --- /dev/null +++ b/curl-install/include/curl/stdcheaders.h @@ -0,0 +1,35 @@ +#ifndef CURLINC_STDCHEADERS_H +#define CURLINC_STDCHEADERS_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#include + +size_t fread(void *, size_t, size_t, FILE *); +size_t fwrite(const void *, size_t, size_t, FILE *); + +int strcasecmp(const char *, const char *); +int strncasecmp(const char *, const char *, size_t); + +#endif /* CURLINC_STDCHEADERS_H */ diff --git a/curl-install/include/curl/system.h b/curl-install/include/curl/system.h new file mode 100644 index 00000000..ebcdc5e4 --- /dev/null +++ b/curl-install/include/curl/system.h @@ -0,0 +1,402 @@ +#ifndef CURLINC_SYSTEM_H +#define CURLINC_SYSTEM_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +/* + * Try to keep one section per platform, compiler and architecture, otherwise, + * if an existing section is reused for a different one and later on the + * original is adjusted, probably the piggybacking one can be adversely + * changed. + * + * In order to differentiate between platforms/compilers/architectures use + * only compiler built-in predefined preprocessor symbols. + * + * curl_off_t + * ---------- + * + * For any given platform/compiler curl_off_t MUST be typedef'ed to a 64-bit + * wide signed integral data type. The width of this data type must remain + * constant and independent of any possible large file support settings. + * + * As a general rule, curl_off_t shall not be mapped to off_t. This rule shall + * only be violated if off_t is the only 64-bit data type available and the + * size of off_t is independent of large file support settings. Keep your + * build on the safe side avoiding an off_t gating. If you have a 64-bit + * off_t then take for sure that another 64-bit data type exists, dig deeper + * and you will find it. + * + */ + +#ifdef __DJGPP__ +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T int + +#elif defined(__BORLANDC__) +# define CURL_TYPEOF_CURL_OFF_T __int64 +# define CURL_FORMAT_CURL_OFF_T "I64d" +# define CURL_FORMAT_CURL_OFF_TU "I64u" +# define CURL_SUFFIX_CURL_OFF_T i64 +# define CURL_SUFFIX_CURL_OFF_TU ui64 +# define CURL_TYPEOF_CURL_SOCKLEN_T int + +#elif defined(__POCC__) +# if defined(_MSC_VER) +# define CURL_TYPEOF_CURL_OFF_T __int64 +# define CURL_FORMAT_CURL_OFF_T "I64d" +# define CURL_FORMAT_CURL_OFF_TU "I64u" +# define CURL_SUFFIX_CURL_OFF_T i64 +# define CURL_SUFFIX_CURL_OFF_TU ui64 +# else +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T int + +#elif defined(__LCC__) +# if defined(__MCST__) /* MCST eLbrus Compiler Collection */ +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 +# else /* Local (or Little) C Compiler */ +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# define CURL_TYPEOF_CURL_SOCKLEN_T int +# endif + +#elif defined(macintosh) +# include +# if TYPE_LONGLONG +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# else +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T unsigned int + +#elif defined(__TANDEM) +# if !defined(__LP64) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T int +# else +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# define CURL_TYPEOF_CURL_SOCKLEN_T unsigned int +# endif + +#elif defined(UNDER_CE) +# if defined(__MINGW32CE__) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T int +# else +# define CURL_TYPEOF_CURL_OFF_T __int64 +# define CURL_FORMAT_CURL_OFF_T "I64d" +# define CURL_FORMAT_CURL_OFF_TU "I64u" +# define CURL_SUFFIX_CURL_OFF_T i64 +# define CURL_SUFFIX_CURL_OFF_TU ui64 +# define CURL_TYPEOF_CURL_SOCKLEN_T int +# endif + +#elif defined(__MINGW32__) +# include +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T PRId64 +# define CURL_FORMAT_CURL_OFF_TU PRIu64 +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T int +# define CURL_PULL_SYS_TYPES_H 1 + +#elif defined(__VMS) +# if defined(__VAX) +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# else +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T unsigned int + +#elif defined(__OS400__) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#elif defined(__MVS__) +# if defined(_LONG_LONG) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# else /* _LP64 and default */ +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#elif defined(__370__) +# if defined(__IBMC__) || defined(__IBMCPP__) +# if defined(_LONG_LONG) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# else /* _LP64 and default */ +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 +# endif + +#elif defined(TPF) +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# define CURL_TYPEOF_CURL_SOCKLEN_T int + +#elif defined(__TINYC__) /* also known as tcc */ +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#elif defined(__SUNPRO_C) || defined(__SUNPRO_CC) /* Oracle Solaris Studio */ +# if !defined(__LP64) && (defined(__ILP32) || \ + defined(__i386) || \ + defined(__sparcv8) || \ + defined(__sparcv8plus)) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# elif defined(__LP64) || \ + defined(__amd64) || defined(__sparcv9) +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#elif defined(__xlc__) /* IBM xlc compiler */ +# if !defined(_LP64) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# else +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#elif defined(__hpux) /* HP aCC compiler */ +# if !defined(_LP64) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# else +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +/* ===================================== */ +/* KEEP MSVC THE PENULTIMATE ENTRY */ +/* ===================================== */ + +#elif defined(_MSC_VER) +# if (_MSC_VER >= 1800) +# include +# define CURL_FORMAT_CURL_OFF_T PRId64 +# define CURL_FORMAT_CURL_OFF_TU PRIu64 +# else +# define CURL_FORMAT_CURL_OFF_T "I64d" +# define CURL_FORMAT_CURL_OFF_TU "I64u" +# endif +# define CURL_TYPEOF_CURL_OFF_T __int64 +# define CURL_SUFFIX_CURL_OFF_T i64 +# define CURL_SUFFIX_CURL_OFF_TU ui64 +# define CURL_TYPEOF_CURL_SOCKLEN_T int + +/* ===================================== */ +/* KEEP GENERIC GCC THE LAST ENTRY */ +/* ===================================== */ + +#elif defined(__GNUC__) && !defined(_SCO_DS) +# if !defined(__LP64__) && \ + (defined(__ILP32__) || defined(__i386__) || defined(__hppa__) || \ + defined(__ppc__) || defined(__powerpc__) || defined(__arm__) || \ + defined(__sparc__) || defined(__mips__) || defined(__sh__) || \ + defined(__XTENSA__) || \ + (defined(__SIZEOF_LONG__) && __SIZEOF_LONG__ == 4) || \ + (defined(__LONG_MAX__) && __LONG_MAX__ == 2147483647L)) +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_POPCOUNT64(x) __builtin_popcountll(x) +# define CURL_CTZ64(x) __builtin_ctzll(x) +# elif defined(__LP64__) || \ + defined(__x86_64__) || defined(__ppc64__) || defined(__sparc64__) || \ + defined(__e2k__) || \ + (defined(__SIZEOF_LONG__) && __SIZEOF_LONG__ == 8) || \ + (defined(__LONG_MAX__) && __LONG_MAX__ == 9223372036854775807L) +# define CURL_TYPEOF_CURL_OFF_T long +# define CURL_FORMAT_CURL_OFF_T "ld" +# define CURL_FORMAT_CURL_OFF_TU "lu" +# define CURL_SUFFIX_CURL_OFF_T L +# define CURL_SUFFIX_CURL_OFF_TU UL +# define CURL_POPCOUNT64(x) __builtin_popcountl(x) +# define CURL_CTZ64(x) __builtin_ctzl(x) +# endif +# define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t +# define CURL_PULL_SYS_TYPES_H 1 +# define CURL_PULL_SYS_SOCKET_H 1 + +#else +/* generic "safe guess" on old 32-bit style */ +# define CURL_TYPEOF_CURL_OFF_T long long +# define CURL_FORMAT_CURL_OFF_T "lld" +# define CURL_FORMAT_CURL_OFF_TU "llu" +# define CURL_SUFFIX_CURL_OFF_T LL +# define CURL_SUFFIX_CURL_OFF_TU ULL +# define CURL_TYPEOF_CURL_SOCKLEN_T int +#endif + +#ifdef _AIX +/* AIX needs */ +#define CURL_PULL_SYS_POLL_H +#endif + +/* CURL_PULL_SYS_TYPES_H is defined above when inclusion of header file */ +/* sys/types.h is required here to properly make type definitions below. */ +#ifdef CURL_PULL_SYS_TYPES_H +# include +#endif + +/* CURL_PULL_SYS_SOCKET_H is defined above when inclusion of header file */ +/* sys/socket.h is required here to properly make type definitions below. */ +#ifdef CURL_PULL_SYS_SOCKET_H +# include +#endif + +/* CURL_PULL_SYS_POLL_H is defined above when inclusion of header file */ +/* sys/poll.h is required here to properly make type definitions below. */ +#ifdef CURL_PULL_SYS_POLL_H +# include +#endif + +/* Data type definition of curl_socklen_t. */ +#ifdef CURL_TYPEOF_CURL_SOCKLEN_T + typedef CURL_TYPEOF_CURL_SOCKLEN_T curl_socklen_t; +#endif + +/* Data type definition of curl_off_t. */ + +#ifdef CURL_TYPEOF_CURL_OFF_T + typedef CURL_TYPEOF_CURL_OFF_T curl_off_t; +#endif + +#endif /* CURLINC_SYSTEM_H */ diff --git a/curl-install/include/curl/typecheck-gcc.h b/curl-install/include/curl/typecheck-gcc.h new file mode 100644 index 00000000..ca0c0ef9 --- /dev/null +++ b/curl-install/include/curl/typecheck-gcc.h @@ -0,0 +1,867 @@ +#ifndef CURLINC_TYPECHECK_GCC_H +#define CURLINC_TYPECHECK_GCC_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +/* wraps curl_easy_setopt() with typechecking */ + +/* To add a new kind of warning, add an + * if(curlcheck_sometype_option(_curl_opt)) + * if(!curlcheck_sometype(value)) + * _curl_easy_setopt_err_sometype(); + * block and define curlcheck_sometype_option, curlcheck_sometype and + * _curl_easy_setopt_err_sometype below + * + * NOTE: We use two nested 'if' statements here instead of the && operator, in + * order to work around gcc bug #32061. It affects only gcc 4.3.x/4.4.x + * when compiling with -Wlogical-op. + * + * To add an option that uses the same type as an existing option, you will + * just need to extend the appropriate _curl_*_option macro + */ + +#define curl_easy_setopt(handle, option, value) \ + __extension__({ \ + if(__builtin_constant_p(option)) { \ + CURL_IGNORE_DEPRECATION( \ + if(curlcheck_long_option(option)) \ + if(!curlcheck_long(value)) \ + _curl_easy_setopt_err_long(); \ + if(curlcheck_off_t_option(option)) \ + if(!curlcheck_off_t(value)) \ + _curl_easy_setopt_err_curl_off_t(); \ + if(curlcheck_string_option(option)) \ + if(!curlcheck_string(value)) \ + _curl_easy_setopt_err_string(); \ + if((option) == CURLOPT_PRIVATE) { } \ + if(curlcheck_write_cb_option(option)) \ + if(!curlcheck_write_cb(value)) \ + _curl_easy_setopt_err_write_callback(); \ + if(curlcheck_curl_option(option)) \ + if(!curlcheck_curl(value)) \ + _curl_easy_setopt_err_curl(); \ + if((option) == CURLOPT_RESOLVER_START_FUNCTION) \ + if(!curlcheck_resolver_start_callback(value)) \ + _curl_easy_setopt_err_resolver_start_callback(); \ + if((option) == CURLOPT_READFUNCTION) \ + if(!curlcheck_read_cb(value)) \ + _curl_easy_setopt_err_read_cb(); \ + if((option) == CURLOPT_IOCTLFUNCTION) \ + if(!curlcheck_ioctl_cb(value)) \ + _curl_easy_setopt_err_ioctl_cb(); \ + if((option) == CURLOPT_SOCKOPTFUNCTION) \ + if(!curlcheck_sockopt_cb(value)) \ + _curl_easy_setopt_err_sockopt_cb(); \ + if((option) == CURLOPT_OPENSOCKETFUNCTION) \ + if(!curlcheck_opensocket_cb(value)) \ + _curl_easy_setopt_err_opensocket_cb(); \ + if((option) == CURLOPT_PROGRESSFUNCTION) \ + if(!curlcheck_progress_cb(value)) \ + _curl_easy_setopt_err_progress_cb(); \ + if((option) == CURLOPT_XFERINFOFUNCTION) \ + if(!curlcheck_xferinfo_cb(value)) \ + _curl_easy_setopt_err_xferinfo_cb(); \ + if((option) == CURLOPT_DEBUGFUNCTION) \ + if(!curlcheck_debug_cb(value)) \ + _curl_easy_setopt_err_debug_cb(); \ + if((option) == CURLOPT_SSL_CTX_FUNCTION) \ + if(!curlcheck_ssl_ctx_cb(value)) \ + _curl_easy_setopt_err_ssl_ctx_cb(); \ + if(curlcheck_conv_cb_option(option)) \ + if(!curlcheck_conv_cb(value)) \ + _curl_easy_setopt_err_conv_cb(); \ + if((option) == CURLOPT_SEEKFUNCTION) \ + if(!curlcheck_seek_cb(value)) \ + _curl_easy_setopt_err_seek_cb(); \ + if((option) == CURLOPT_CHUNK_BGN_FUNCTION) \ + if(!curlcheck_chunk_bgn_cb(value)) \ + _curl_easy_setopt_err_chunk_bgn_cb(); \ + if((option) == CURLOPT_CHUNK_END_FUNCTION) \ + if(!curlcheck_chunk_end_cb(value)) \ + _curl_easy_setopt_err_chunk_end_cb(); \ + if((option) == CURLOPT_CLOSESOCKETFUNCTION) \ + if(!curlcheck_close_socket_cb(value)) \ + _curl_easy_setopt_err_close_socket_cb(); \ + if((option) == CURLOPT_FNMATCH_FUNCTION) \ + if(!curlcheck_fnmatch_cb(value)) \ + _curl_easy_setopt_err_fnmatch_cb(); \ + if((option) == CURLOPT_HSTSREADFUNCTION) \ + if(!curlcheck_hstsread_cb(value)) \ + _curl_easy_setopt_err_hstsread_cb(); \ + if((option) == CURLOPT_HSTSWRITEFUNCTION) \ + if(!curlcheck_hstswrite_cb(value)) \ + _curl_easy_setopt_err_hstswrite_cb(); \ + if((option) == CURLOPT_SSH_HOSTKEYFUNCTION) \ + if(!curlcheck_ssh_hostkey_cb(value)) \ + _curl_easy_setopt_err_ssh_hostkey_cb(); \ + if((option) == CURLOPT_SSH_KEYFUNCTION) \ + if(!curlcheck_ssh_key_cb(value)) \ + _curl_easy_setopt_err_ssh_key_cb(); \ + if((option) == CURLOPT_INTERLEAVEFUNCTION) \ + if(!curlcheck_interleave_cb(value)) \ + _curl_easy_setopt_err_interleave_cb(); \ + if((option) == CURLOPT_PREREQFUNCTION) \ + if(!curlcheck_prereq_cb(value)) \ + _curl_easy_setopt_err_prereq_cb(); \ + if((option) == CURLOPT_TRAILERFUNCTION) \ + if(!curlcheck_trailer_cb(value)) \ + _curl_easy_setopt_err_trailer_cb(); \ + if(curlcheck_cb_data_option(option)) \ + if(!curlcheck_cb_data(value)) \ + _curl_easy_setopt_err_cb_data(); \ + if((option) == CURLOPT_ERRORBUFFER) \ + if(!curlcheck_error_buffer(value)) \ + _curl_easy_setopt_err_error_buffer(); \ + if((option) == CURLOPT_CURLU) \ + if(!curlcheck_ptr((value), CURLU)) \ + _curl_easy_setopt_err_curlu(); \ + if((option) == CURLOPT_STDERR) \ + if(!curlcheck_FILE(value)) \ + _curl_easy_setopt_err_FILE(); \ + if(curlcheck_postfields_option(option)) \ + if(!curlcheck_postfields(value)) \ + _curl_easy_setopt_err_postfields(); \ + if((option) == CURLOPT_HTTPPOST) \ + if(!curlcheck_arr((value), struct curl_httppost)) \ + _curl_easy_setopt_err_curl_httpost(); \ + if((option) == CURLOPT_MIMEPOST) \ + if(!curlcheck_ptr((value), curl_mime)) \ + _curl_easy_setopt_err_curl_mimepost(); \ + if(curlcheck_slist_option(option)) \ + if(!curlcheck_arr((value), struct curl_slist)) \ + _curl_easy_setopt_err_curl_slist(); \ + if((option) == CURLOPT_SHARE) \ + if(!curlcheck_ptr((value), CURLSH)) \ + _curl_easy_setopt_err_CURLSH(); \ + ) \ + } \ + curl_easy_setopt(handle, option, value); \ + }) + +/* wraps curl_easy_getinfo() with typechecking */ +#define curl_easy_getinfo(handle, info, arg) \ + __extension__({ \ + if(__builtin_constant_p(info)) { \ + CURL_IGNORE_DEPRECATION( \ + if(curlcheck_string_info(info)) \ + if(!curlcheck_arr((arg), char *)) \ + _curl_easy_getinfo_err_string(); \ + if(curlcheck_long_info(info)) \ + if(!curlcheck_arr((arg), long)) \ + _curl_easy_getinfo_err_long(); \ + if(curlcheck_double_info(info)) \ + if(!curlcheck_arr((arg), double)) \ + _curl_easy_getinfo_err_double(); \ + if(curlcheck_slist_info(info)) \ + if(!curlcheck_arr((arg), struct curl_slist *)) \ + _curl_easy_getinfo_err_curl_slist(); \ + if(curlcheck_tlssessioninfo_info(info)) \ + if(!curlcheck_arr((arg), struct curl_tlssessioninfo *)) \ + _curl_easy_getinfo_err_curl_tlssessioninfo(); \ + if(curlcheck_certinfo_info(info)) \ + if(!curlcheck_arr((arg), struct curl_certinfo *)) \ + _curl_easy_getinfo_err_curl_certinfo(); \ + if(curlcheck_socket_info(info)) \ + if(!curlcheck_arr((arg), curl_socket_t)) \ + _curl_easy_getinfo_err_curl_socket(); \ + if(curlcheck_off_t_info(info)) \ + if(!curlcheck_arr((arg), curl_off_t)) \ + _curl_easy_getinfo_err_curl_off_t(); \ + ) \ + } \ + curl_easy_getinfo(handle, info, arg); \ + }) + +/* + * For now, just make sure that the functions are called with three arguments + */ +#define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) +#define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) + +/* the actual warnings, triggered by calling the _curl_easy_setopt_err* + * functions */ + +/* To define a new warning, use _CURL_WARNING(identifier, "message") */ +#define CURLWARNING(id, message) \ + static void __attribute__((__warning__(message))) \ + __attribute__((__unused__)) __attribute__((__noinline__)) \ + id(void) { __asm__(""); } + +CURLWARNING(_curl_easy_setopt_err_long, + "curl_easy_setopt expects a long argument") +CURLWARNING(_curl_easy_setopt_err_curl_off_t, + "curl_easy_setopt expects a curl_off_t argument") +CURLWARNING(_curl_easy_setopt_err_string, + "curl_easy_setopt expects a " + "string ('char *' or char[]) argument") +CURLWARNING(_curl_easy_setopt_err_write_callback, + "curl_easy_setopt expects a curl_write_callback argument") +CURLWARNING(_curl_easy_setopt_err_resolver_start_callback, + "curl_easy_setopt expects a " + "curl_resolver_start_callback argument") +CURLWARNING(_curl_easy_setopt_err_read_cb, + "curl_easy_setopt expects a curl_read_callback argument") +CURLWARNING(_curl_easy_setopt_err_ioctl_cb, + "curl_easy_setopt expects a curl_ioctl_callback argument") +CURLWARNING(_curl_easy_setopt_err_sockopt_cb, + "curl_easy_setopt expects a curl_sockopt_callback argument") +CURLWARNING(_curl_easy_setopt_err_opensocket_cb, + "curl_easy_setopt expects a " + "curl_opensocket_callback argument") +CURLWARNING(_curl_easy_setopt_err_progress_cb, + "curl_easy_setopt expects a curl_progress_callback argument") +CURLWARNING(_curl_easy_setopt_err_xferinfo_cb, + "curl_easy_setopt expects a curl_xferinfo_callback argument") +CURLWARNING(_curl_easy_setopt_err_debug_cb, + "curl_easy_setopt expects a curl_debug_callback argument") +CURLWARNING(_curl_easy_setopt_err_ssl_ctx_cb, + "curl_easy_setopt expects a curl_ssl_ctx_callback argument") +CURLWARNING(_curl_easy_setopt_err_conv_cb, + "curl_easy_setopt expects a curl_conv_callback argument") +CURLWARNING(_curl_easy_setopt_err_seek_cb, + "curl_easy_setopt expects a curl_seek_callback argument") +CURLWARNING(_curl_easy_setopt_err_cb_data, + "curl_easy_setopt expects a " + "private data pointer as argument") +CURLWARNING(_curl_easy_setopt_err_chunk_bgn_cb, + "curl_easy_setopt expects a curl_chunk_bgn_callback argument") +CURLWARNING(_curl_easy_setopt_err_chunk_end_cb, + "curl_easy_setopt expects a curl_chunk_end_callback argument") +CURLWARNING(_curl_easy_setopt_err_close_socket_cb, + "curl_easy_setopt expects a curl_closesocket_callback argument") +CURLWARNING(_curl_easy_setopt_err_fnmatch_cb, + "curl_easy_setopt expects a curl_fnmatch_callback argument") +CURLWARNING(_curl_easy_setopt_err_hstsread_cb, + "curl_easy_setopt expects a curl_hstsread_callback argument") +CURLWARNING(_curl_easy_setopt_err_hstswrite_cb, + "curl_easy_setopt expects a curl_hstswrite_callback argument") +CURLWARNING(_curl_easy_setopt_err_ssh_key_cb, + "curl_easy_setopt expects a curl_sshkeycallback argument") +CURLWARNING(_curl_easy_setopt_err_ssh_hostkey_cb, + "curl_easy_setopt expects a curl_sshhostkeycallback argument") +CURLWARNING(_curl_easy_setopt_err_interleave_cb, + "curl_easy_setopt expects a curl_interleave_callback argument") +CURLWARNING(_curl_easy_setopt_err_prereq_cb, + "curl_easy_setopt expects a curl_prereq_callback argument") +CURLWARNING(_curl_easy_setopt_err_trailer_cb, + "curl_easy_setopt expects a curl_trailerfunc_ok argument") +CURLWARNING(_curl_easy_setopt_err_error_buffer, + "curl_easy_setopt expects a " + "char buffer of CURL_ERROR_SIZE as argument") +CURLWARNING(_curl_easy_setopt_err_curlu, + "curl_easy_setopt expects a 'CURLU *' argument") +CURLWARNING(_curl_easy_setopt_err_curl, + "curl_easy_setopt expects a 'CURL *' argument") +CURLWARNING(_curl_easy_setopt_err_FILE, + "curl_easy_setopt expects a 'FILE *' argument") +CURLWARNING(_curl_easy_setopt_err_postfields, + "curl_easy_setopt expects a 'void *' or 'char *' argument") +CURLWARNING(_curl_easy_setopt_err_curl_httpost, + "curl_easy_setopt expects a 'struct curl_httppost *' " + "argument") +CURLWARNING(_curl_easy_setopt_err_curl_mimepost, + "curl_easy_setopt expects a 'curl_mime *' " + "argument") +CURLWARNING(_curl_easy_setopt_err_curl_slist, + "curl_easy_setopt expects a 'struct curl_slist *' argument") +CURLWARNING(_curl_easy_setopt_err_CURLSH, + "curl_easy_setopt expects a CURLSH* argument") +CURLWARNING(_curl_easy_getinfo_err_string, + "curl_easy_getinfo expects a pointer to 'char *'") +CURLWARNING(_curl_easy_getinfo_err_long, + "curl_easy_getinfo expects a pointer to long") +CURLWARNING(_curl_easy_getinfo_err_double, + "curl_easy_getinfo expects a pointer to double") +CURLWARNING(_curl_easy_getinfo_err_curl_slist, + "curl_easy_getinfo expects a pointer to 'struct curl_slist *'") +CURLWARNING(_curl_easy_getinfo_err_curl_tlssessioninfo, + "curl_easy_getinfo expects a pointer to " + "'struct curl_tlssessioninfo *'") +CURLWARNING(_curl_easy_getinfo_err_curl_certinfo, + "curl_easy_getinfo expects a pointer to " + "'struct curl_certinfo *'") +CURLWARNING(_curl_easy_getinfo_err_curl_socket, + "curl_easy_getinfo expects a pointer to curl_socket_t") +CURLWARNING(_curl_easy_getinfo_err_curl_off_t, + "curl_easy_getinfo expects a pointer to curl_off_t") + +/* groups of curl_easy_setops options that take the same type of argument */ + +/* evaluates to true if option takes a long argument */ +#define curlcheck_long_option(option) \ + (0 < (option) && (option) < CURLOPTTYPE_OBJECTPOINT) + +#define curlcheck_off_t_option(option) \ + (((option) > CURLOPTTYPE_OFF_T) && ((option) < CURLOPTTYPE_BLOB)) + +/* option takes a CURL * argument */ +#define curlcheck_curl_option(option) \ + ((option) == CURLOPT_STREAM_DEPENDS || \ + (option) == CURLOPT_STREAM_DEPENDS_E || \ + 0) + +/* evaluates to true if option takes a char* argument */ +#define curlcheck_string_option(option) \ + ((option) == CURLOPT_ABSTRACT_UNIX_SOCKET || \ + (option) == CURLOPT_ACCEPT_ENCODING || \ + (option) == CURLOPT_ALTSVC || \ + (option) == CURLOPT_CAINFO || \ + (option) == CURLOPT_CAPATH || \ + (option) == CURLOPT_COOKIE || \ + (option) == CURLOPT_COOKIEFILE || \ + (option) == CURLOPT_COOKIEJAR || \ + (option) == CURLOPT_COOKIELIST || \ + (option) == CURLOPT_CRLFILE || \ + (option) == CURLOPT_CUSTOMREQUEST || \ + (option) == CURLOPT_DEFAULT_PROTOCOL || \ + (option) == CURLOPT_DNS_INTERFACE || \ + (option) == CURLOPT_DNS_LOCAL_IP4 || \ + (option) == CURLOPT_DNS_LOCAL_IP6 || \ + (option) == CURLOPT_DNS_SERVERS || \ + (option) == CURLOPT_DOH_URL || \ + (option) == CURLOPT_ECH || \ + (option) == CURLOPT_EGDSOCKET || \ + (option) == CURLOPT_FTP_ACCOUNT || \ + (option) == CURLOPT_FTP_ALTERNATIVE_TO_USER || \ + (option) == CURLOPT_FTPPORT || \ + (option) == CURLOPT_HAPROXY_CLIENT_IP || \ + (option) == CURLOPT_HSTS || \ + (option) == CURLOPT_INTERFACE || \ + (option) == CURLOPT_ISSUERCERT || \ + (option) == CURLOPT_KEYPASSWD || \ + (option) == CURLOPT_KRBLEVEL || \ + (option) == CURLOPT_LOGIN_OPTIONS || \ + (option) == CURLOPT_MAIL_AUTH || \ + (option) == CURLOPT_MAIL_FROM || \ + (option) == CURLOPT_NETRC_FILE || \ + (option) == CURLOPT_NOPROXY || \ + (option) == CURLOPT_PASSWORD || \ + (option) == CURLOPT_PINNEDPUBLICKEY || \ + (option) == CURLOPT_PRE_PROXY || \ + (option) == CURLOPT_PROTOCOLS_STR || \ + (option) == CURLOPT_PROXY || \ + (option) == CURLOPT_PROXY_CAINFO || \ + (option) == CURLOPT_PROXY_CAPATH || \ + (option) == CURLOPT_PROXY_CRLFILE || \ + (option) == CURLOPT_PROXY_ISSUERCERT || \ + (option) == CURLOPT_PROXY_KEYPASSWD || \ + (option) == CURLOPT_PROXY_PINNEDPUBLICKEY || \ + (option) == CURLOPT_PROXY_SERVICE_NAME || \ + (option) == CURLOPT_PROXY_SSL_CIPHER_LIST || \ + (option) == CURLOPT_PROXY_SSLCERT || \ + (option) == CURLOPT_PROXY_SSLCERTTYPE || \ + (option) == CURLOPT_PROXY_SSLKEY || \ + (option) == CURLOPT_PROXY_SSLKEYTYPE || \ + (option) == CURLOPT_PROXY_TLS13_CIPHERS || \ + (option) == CURLOPT_PROXY_TLSAUTH_PASSWORD || \ + (option) == CURLOPT_PROXY_TLSAUTH_TYPE || \ + (option) == CURLOPT_PROXY_TLSAUTH_USERNAME || \ + (option) == CURLOPT_PROXYPASSWORD || \ + (option) == CURLOPT_PROXYUSERNAME || \ + (option) == CURLOPT_PROXYUSERPWD || \ + (option) == CURLOPT_RANDOM_FILE || \ + (option) == CURLOPT_RANGE || \ + (option) == CURLOPT_REDIR_PROTOCOLS_STR || \ + (option) == CURLOPT_REFERER || \ + (option) == CURLOPT_REQUEST_TARGET || \ + (option) == CURLOPT_RTSP_SESSION_ID || \ + (option) == CURLOPT_RTSP_STREAM_URI || \ + (option) == CURLOPT_RTSP_TRANSPORT || \ + (option) == CURLOPT_SASL_AUTHZID || \ + (option) == CURLOPT_SERVICE_NAME || \ + (option) == CURLOPT_SOCKS5_GSSAPI_SERVICE || \ + (option) == CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 || \ + (option) == CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 || \ + (option) == CURLOPT_SSH_KNOWNHOSTS || \ + (option) == CURLOPT_SSH_PRIVATE_KEYFILE || \ + (option) == CURLOPT_SSH_PUBLIC_KEYFILE || \ + (option) == CURLOPT_SSLCERT || \ + (option) == CURLOPT_SSLCERTTYPE || \ + (option) == CURLOPT_SSLENGINE || \ + (option) == CURLOPT_SSLKEY || \ + (option) == CURLOPT_SSLKEYTYPE || \ + (option) == CURLOPT_SSL_CIPHER_LIST || \ + (option) == CURLOPT_SSL_EC_CURVES || \ + (option) == CURLOPT_SSL_SIGNATURE_ALGORITHMS || \ + (option) == CURLOPT_TLS13_CIPHERS || \ + (option) == CURLOPT_TLSAUTH_PASSWORD || \ + (option) == CURLOPT_TLSAUTH_TYPE || \ + (option) == CURLOPT_TLSAUTH_USERNAME || \ + (option) == CURLOPT_UNIX_SOCKET_PATH || \ + (option) == CURLOPT_URL || \ + (option) == CURLOPT_USERAGENT || \ + (option) == CURLOPT_USERNAME || \ + (option) == CURLOPT_AWS_SIGV4 || \ + (option) == CURLOPT_USERPWD || \ + (option) == CURLOPT_XOAUTH2_BEARER || \ + 0) + +/* evaluates to true if option takes a curl_write_callback argument */ +#define curlcheck_write_cb_option(option) \ + ((option) == CURLOPT_HEADERFUNCTION || \ + (option) == CURLOPT_WRITEFUNCTION) + +/* evaluates to true if option takes a curl_conv_callback argument */ +#define curlcheck_conv_cb_option(option) \ + ((option) == CURLOPT_CONV_TO_NETWORK_FUNCTION || \ + (option) == CURLOPT_CONV_FROM_NETWORK_FUNCTION || \ + (option) == CURLOPT_CONV_FROM_UTF8_FUNCTION) + +/* evaluates to true if option takes a data argument to pass to a callback */ +#define curlcheck_cb_data_option(option) \ + ((option) == CURLOPT_CHUNK_DATA || \ + (option) == CURLOPT_CLOSESOCKETDATA || \ + (option) == CURLOPT_DEBUGDATA || \ + (option) == CURLOPT_FNMATCH_DATA || \ + (option) == CURLOPT_HEADERDATA || \ + (option) == CURLOPT_HSTSREADDATA || \ + (option) == CURLOPT_HSTSWRITEDATA || \ + (option) == CURLOPT_INTERLEAVEDATA || \ + (option) == CURLOPT_IOCTLDATA || \ + (option) == CURLOPT_OPENSOCKETDATA || \ + (option) == CURLOPT_PREREQDATA || \ + (option) == CURLOPT_XFERINFODATA || \ + (option) == CURLOPT_READDATA || \ + (option) == CURLOPT_SEEKDATA || \ + (option) == CURLOPT_SOCKOPTDATA || \ + (option) == CURLOPT_SSH_KEYDATA || \ + (option) == CURLOPT_SSL_CTX_DATA || \ + (option) == CURLOPT_WRITEDATA || \ + (option) == CURLOPT_RESOLVER_START_DATA || \ + (option) == CURLOPT_TRAILERDATA || \ + (option) == CURLOPT_SSH_HOSTKEYDATA || \ + 0) + +/* evaluates to true if option takes a POST data argument (void* or char*) */ +#define curlcheck_postfields_option(option) \ + ((option) == CURLOPT_POSTFIELDS || \ + (option) == CURLOPT_COPYPOSTFIELDS || \ + 0) + +/* evaluates to true if option takes a struct curl_slist * argument */ +#define curlcheck_slist_option(option) \ + ((option) == CURLOPT_HTTP200ALIASES || \ + (option) == CURLOPT_HTTPHEADER || \ + (option) == CURLOPT_MAIL_RCPT || \ + (option) == CURLOPT_POSTQUOTE || \ + (option) == CURLOPT_PREQUOTE || \ + (option) == CURLOPT_PROXYHEADER || \ + (option) == CURLOPT_QUOTE || \ + (option) == CURLOPT_RESOLVE || \ + (option) == CURLOPT_TELNETOPTIONS || \ + (option) == CURLOPT_CONNECT_TO || \ + 0) + +/* groups of curl_easy_getinfo infos that take the same type of argument */ + +/* evaluates to true if info expects a pointer to char * argument */ +#define curlcheck_string_info(info) \ + (CURLINFO_STRING < (info) && (info) < CURLINFO_LONG && \ + (info) != CURLINFO_PRIVATE) + +/* evaluates to true if info expects a pointer to long argument */ +#define curlcheck_long_info(info) \ + (CURLINFO_LONG < (info) && (info) < CURLINFO_DOUBLE) + +/* evaluates to true if info expects a pointer to double argument */ +#define curlcheck_double_info(info) \ + (CURLINFO_DOUBLE < (info) && (info) < CURLINFO_SLIST) + +/* true if info expects a pointer to struct curl_slist * argument */ +#define curlcheck_slist_info(info) \ + (((info) == CURLINFO_SSL_ENGINES) || ((info) == CURLINFO_COOKIELIST)) + +/* true if info expects a pointer to struct curl_tlssessioninfo * argument */ +#define curlcheck_tlssessioninfo_info(info) \ + (((info) == CURLINFO_TLS_SSL_PTR) || ((info) == CURLINFO_TLS_SESSION)) + +/* true if info expects a pointer to struct curl_certinfo * argument */ +#define curlcheck_certinfo_info(info) ((info) == CURLINFO_CERTINFO) + +/* true if info expects a pointer to struct curl_socket_t argument */ +#define curlcheck_socket_info(info) \ + (CURLINFO_SOCKET < (info) && (info) < CURLINFO_OFF_T) + +/* true if info expects a pointer to curl_off_t argument */ +#define curlcheck_off_t_info(info) \ + (CURLINFO_OFF_T < (info)) + + +/* typecheck helpers -- check whether given expression has requested type */ + +/* For pointers, you can use the curlcheck_ptr/curlcheck_arr macros, + * otherwise define a new macro. Search for __builtin_types_compatible_p + * in the GCC manual. + * NOTE: these macros MUST NOT EVALUATE their arguments! The argument is + * the actual expression passed to the curl_easy_setopt macro. This + * means that you can only apply the sizeof and __typeof__ operators, no + * == or whatsoever. + */ + +/* XXX: should evaluate to true if expr is a pointer */ +#define curlcheck_any_ptr(expr) \ + (sizeof(expr) == sizeof(void *)) + +/* evaluates to true if expr is NULL */ +/* XXX: must not evaluate expr, so this check is not accurate */ +#define curlcheck_NULL(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), __typeof__(NULL))) + +/* evaluates to true if expr is type*, const type* or NULL */ +#define curlcheck_ptr(expr, type) \ + (curlcheck_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), type *) || \ + __builtin_types_compatible_p(__typeof__(expr), const type *)) + +/* evaluates to true if expr is one of type[], type*, NULL or const type* */ +#define curlcheck_arr(expr, type) \ + (curlcheck_ptr((expr), type) || \ + __builtin_types_compatible_p(__typeof__(expr), type [])) + +/* evaluates to true if expr is a string */ +#define curlcheck_string(expr) \ + (curlcheck_arr((expr), char) || \ + curlcheck_arr((expr), signed char) || \ + curlcheck_arr((expr), unsigned char)) + +/* evaluates to true if expr is a CURL * */ +#define curlcheck_curl(expr) \ + (curlcheck_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), CURL *)) + + +/* evaluates to true if expr is a long (no matter the signedness) + * XXX: for now, int is also accepted (and therefore short and char, which + * are promoted to int when passed to a variadic function) */ +#define curlcheck_long(expr) \ + ( \ + ((sizeof(long) != sizeof(int)) && \ + (__builtin_types_compatible_p(__typeof__(expr), long) || \ + __builtin_types_compatible_p(__typeof__(expr), signed long) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned long))) \ + || \ + ((sizeof(long) == sizeof(int)) && \ + (__builtin_types_compatible_p(__typeof__(expr), long) || \ + __builtin_types_compatible_p(__typeof__(expr), signed long) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned long) || \ + __builtin_types_compatible_p(__typeof__(expr), int) || \ + __builtin_types_compatible_p(__typeof__(expr), signed int) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned int) || \ + __builtin_types_compatible_p(__typeof__(expr), short) || \ + __builtin_types_compatible_p(__typeof__(expr), signed short) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned short) || \ + __builtin_types_compatible_p(__typeof__(expr), char) || \ + __builtin_types_compatible_p(__typeof__(expr), signed char) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned char))) \ + ) + +/* evaluates to true if expr is of type curl_off_t */ +#define curlcheck_off_t(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), curl_off_t)) + +/* evaluates to true if expr is abuffer suitable for CURLOPT_ERRORBUFFER */ +/* XXX: also check size of an char[] array? */ +#define curlcheck_error_buffer(expr) \ + (curlcheck_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), char *) || \ + __builtin_types_compatible_p(__typeof__(expr), char[])) + +/* evaluates to true if expr is of type (const) void* or (const) FILE* */ +#if 0 +#define curlcheck_cb_data(expr) \ + (curlcheck_ptr((expr), void) || \ + curlcheck_ptr((expr), FILE)) +#else /* be less strict */ +#define curlcheck_cb_data(expr) \ + curlcheck_any_ptr(expr) +#endif + +/* evaluates to true if expr is of type FILE* */ +#define curlcheck_FILE(expr) \ + (curlcheck_NULL(expr) || \ + (__builtin_types_compatible_p(__typeof__(expr), FILE *))) + +/* evaluates to true if expr can be passed as POST data (void* or char*) */ +#define curlcheck_postfields(expr) \ + (curlcheck_ptr((expr), void) || \ + curlcheck_arr((expr), char) || \ + curlcheck_arr((expr), unsigned char)) + +/* helper: __builtin_types_compatible_p distinguishes between functions and + * function pointers, hide it */ +#define curlcheck_cb_compatible(func, type) \ + (__builtin_types_compatible_p(__typeof__(func), type) || \ + __builtin_types_compatible_p(__typeof__(func) *, type)) + +/* evaluates to true if expr is of type curl_resolver_start_callback */ +#define curlcheck_resolver_start_callback(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_resolver_start_callback)) + +/* evaluates to true if expr is of type curl_read_callback or "similar" */ +#define curlcheck_read_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), __typeof__(fread) *) || \ + curlcheck_cb_compatible((expr), curl_read_callback) || \ + curlcheck_cb_compatible((expr), _curl_read_callback1) || \ + curlcheck_cb_compatible((expr), _curl_read_callback2) || \ + curlcheck_cb_compatible((expr), _curl_read_callback3) || \ + curlcheck_cb_compatible((expr), _curl_read_callback4) || \ + curlcheck_cb_compatible((expr), _curl_read_callback5) || \ + curlcheck_cb_compatible((expr), _curl_read_callback6)) +typedef size_t (*_curl_read_callback1)(char *, size_t, size_t, void *); +typedef size_t (*_curl_read_callback2)(char *, size_t, size_t, const void *); +typedef size_t (*_curl_read_callback3)(char *, size_t, size_t, FILE *); +typedef size_t (*_curl_read_callback4)(void *, size_t, size_t, void *); +typedef size_t (*_curl_read_callback5)(void *, size_t, size_t, const void *); +typedef size_t (*_curl_read_callback6)(void *, size_t, size_t, FILE *); + +/* evaluates to true if expr is of type curl_write_callback or "similar" */ +#define curlcheck_write_cb(expr) \ + (curlcheck_read_cb(expr) || \ + curlcheck_cb_compatible((expr), __typeof__(fwrite) *) || \ + curlcheck_cb_compatible((expr), curl_write_callback) || \ + curlcheck_cb_compatible((expr), _curl_write_callback1) || \ + curlcheck_cb_compatible((expr), _curl_write_callback2) || \ + curlcheck_cb_compatible((expr), _curl_write_callback3) || \ + curlcheck_cb_compatible((expr), _curl_write_callback4) || \ + curlcheck_cb_compatible((expr), _curl_write_callback5) || \ + curlcheck_cb_compatible((expr), _curl_write_callback6)) +typedef size_t (*_curl_write_callback1)(const char *, size_t, size_t, void *); +typedef size_t (*_curl_write_callback2)(const char *, size_t, size_t, + const void *); +typedef size_t (*_curl_write_callback3)(const char *, size_t, size_t, FILE *); +typedef size_t (*_curl_write_callback4)(const void *, size_t, size_t, void *); +typedef size_t (*_curl_write_callback5)(const void *, size_t, size_t, + const void *); +typedef size_t (*_curl_write_callback6)(const void *, size_t, size_t, FILE *); + +/* evaluates to true if expr is of type curl_ioctl_callback or "similar" */ +#define curlcheck_ioctl_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_ioctl_callback) || \ + curlcheck_cb_compatible((expr), _curl_ioctl_callback1) || \ + curlcheck_cb_compatible((expr), _curl_ioctl_callback2) || \ + curlcheck_cb_compatible((expr), _curl_ioctl_callback3) || \ + curlcheck_cb_compatible((expr), _curl_ioctl_callback4)) +typedef curlioerr (*_curl_ioctl_callback1)(CURL *, int, void *); +typedef curlioerr (*_curl_ioctl_callback2)(CURL *, int, const void *); +typedef curlioerr (*_curl_ioctl_callback3)(CURL *, curliocmd, void *); +typedef curlioerr (*_curl_ioctl_callback4)(CURL *, curliocmd, const void *); + +/* evaluates to true if expr is of type curl_sockopt_callback or "similar" */ +#define curlcheck_sockopt_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_sockopt_callback) || \ + curlcheck_cb_compatible((expr), _curl_sockopt_callback1) || \ + curlcheck_cb_compatible((expr), _curl_sockopt_callback2)) +typedef int (*_curl_sockopt_callback1)(void *, curl_socket_t, curlsocktype); +typedef int (*_curl_sockopt_callback2)(const void *, curl_socket_t, + curlsocktype); + +/* evaluates to true if expr is of type curl_opensocket_callback or + "similar" */ +#define curlcheck_opensocket_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_opensocket_callback) || \ + curlcheck_cb_compatible((expr), _curl_opensocket_callback1) || \ + curlcheck_cb_compatible((expr), _curl_opensocket_callback2) || \ + curlcheck_cb_compatible((expr), _curl_opensocket_callback3) || \ + curlcheck_cb_compatible((expr), _curl_opensocket_callback4)) +typedef curl_socket_t (*_curl_opensocket_callback1) + (void *, curlsocktype, struct curl_sockaddr *); +typedef curl_socket_t (*_curl_opensocket_callback2) + (void *, curlsocktype, const struct curl_sockaddr *); +typedef curl_socket_t (*_curl_opensocket_callback3) + (const void *, curlsocktype, struct curl_sockaddr *); +typedef curl_socket_t (*_curl_opensocket_callback4) + (const void *, curlsocktype, const struct curl_sockaddr *); + +/* evaluates to true if expr is of type curl_progress_callback or "similar" */ +#define curlcheck_progress_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_progress_callback) || \ + curlcheck_cb_compatible((expr), _curl_progress_callback1) || \ + curlcheck_cb_compatible((expr), _curl_progress_callback2)) +typedef int (*_curl_progress_callback1)(void *, + double, double, double, double); +typedef int (*_curl_progress_callback2)(const void *, + double, double, double, double); + +/* evaluates to true if expr is of type curl_xferinfo_callback */ +#define curlcheck_xferinfo_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_xferinfo_callback)) + +/* evaluates to true if expr is of type curl_debug_callback or "similar" */ +#define curlcheck_debug_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_debug_callback) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback1) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback2) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback3) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback4) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback5) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback6) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback7) || \ + curlcheck_cb_compatible((expr), _curl_debug_callback8)) +typedef int (*_curl_debug_callback1) (CURL *, + curl_infotype, char *, size_t, void *); +typedef int (*_curl_debug_callback2) (CURL *, + curl_infotype, char *, size_t, const void *); +typedef int (*_curl_debug_callback3) (CURL *, + curl_infotype, const char *, size_t, void *); +typedef int (*_curl_debug_callback4) (CURL *, + curl_infotype, const char *, size_t, const void *); +typedef int (*_curl_debug_callback5) (CURL *, + curl_infotype, unsigned char *, size_t, void *); +typedef int (*_curl_debug_callback6) (CURL *, + curl_infotype, unsigned char *, size_t, const void *); +typedef int (*_curl_debug_callback7) (CURL *, + curl_infotype, const unsigned char *, size_t, void *); +typedef int (*_curl_debug_callback8) (CURL *, + curl_infotype, const unsigned char *, size_t, const void *); + +/* evaluates to true if expr is of type curl_ssl_ctx_callback or "similar" */ +/* this is getting even messier... */ +#define curlcheck_ssl_ctx_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_ssl_ctx_callback) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback1) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback2) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback3) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback4) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback5) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback6) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback7) || \ + curlcheck_cb_compatible((expr), _curl_ssl_ctx_callback8)) +typedef CURLcode (*_curl_ssl_ctx_callback1)(CURL *, void *, void *); +typedef CURLcode (*_curl_ssl_ctx_callback2)(CURL *, void *, const void *); +typedef CURLcode (*_curl_ssl_ctx_callback3)(CURL *, const void *, void *); +typedef CURLcode (*_curl_ssl_ctx_callback4)(CURL *, const void *, + const void *); +#ifdef HEADER_SSL_H +/* hack: if we included OpenSSL's ssl.h, we know about SSL_CTX + * this will of course break if we are included before OpenSSL headers... + */ +typedef CURLcode (*_curl_ssl_ctx_callback5)(CURL *, SSL_CTX *, void *); +typedef CURLcode (*_curl_ssl_ctx_callback6)(CURL *, SSL_CTX *, const void *); +typedef CURLcode (*_curl_ssl_ctx_callback7)(CURL *, const SSL_CTX *, void *); +typedef CURLcode (*_curl_ssl_ctx_callback8)(CURL *, const SSL_CTX *, + const void *); +#else +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback5; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback6; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback7; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback8; +#endif + +/* evaluates to true if expr is of type curl_conv_callback or "similar" */ +#define curlcheck_conv_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_conv_callback) || \ + curlcheck_cb_compatible((expr), _curl_conv_callback1) || \ + curlcheck_cb_compatible((expr), _curl_conv_callback2) || \ + curlcheck_cb_compatible((expr), _curl_conv_callback3) || \ + curlcheck_cb_compatible((expr), _curl_conv_callback4)) +typedef CURLcode (*_curl_conv_callback1)(char *, size_t length); +typedef CURLcode (*_curl_conv_callback2)(const char *, size_t length); +typedef CURLcode (*_curl_conv_callback3)(void *, size_t length); +typedef CURLcode (*_curl_conv_callback4)(const void *, size_t length); + +/* evaluates to true if expr is of type curl_seek_callback or "similar" */ +#define curlcheck_seek_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_seek_callback) || \ + curlcheck_cb_compatible((expr), _curl_seek_callback1) || \ + curlcheck_cb_compatible((expr), _curl_seek_callback2)) +typedef CURLcode (*_curl_seek_callback1)(void *, curl_off_t, int); +typedef CURLcode (*_curl_seek_callback2)(const void *, curl_off_t, int); + +/* evaluates to true if expr is of type curl_chunk_bgn_callback */ +#define curlcheck_chunk_bgn_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_chunk_bgn_callback) || \ + curlcheck_cb_compatible((expr), _curl_chunk_bgn_callback1) || \ + curlcheck_cb_compatible((expr), _curl_chunk_bgn_callback2)) +typedef long (*_curl_chunk_bgn_callback1)(struct curl_fileinfo *, + void *, int); +typedef long (*_curl_chunk_bgn_callback2)(void *, void *, int); + +/* evaluates to true if expr is of type curl_chunk_end_callback */ +#define curlcheck_chunk_end_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_chunk_end_callback)) + +/* evaluates to true if expr is of type curl_closesocket_callback */ +#define curlcheck_close_socket_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_closesocket_callback)) + +/* evaluates to true if expr is of type curl_fnmatch_callback */ +#define curlcheck_fnmatch_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_fnmatch_callback)) + +/* evaluates to true if expr is of type curl_hstsread_callback */ +#define curlcheck_hstsread_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_hstsread_callback)) + +/* evaluates to true if expr is of type curl_hstswrite_callback */ +#define curlcheck_hstswrite_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_hstswrite_callback)) + +/* evaluates to true if expr is of type curl_sshhostkeycallback */ +#define curlcheck_ssh_hostkey_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_sshhostkeycallback)) + +/* evaluates to true if expr is of type curl_sshkeycallback */ +#define curlcheck_ssh_key_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_sshkeycallback)) + +/* evaluates to true if expr is of type curl_interleave_callback */ +#define curlcheck_interleave_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), _curl_interleave_callback1) || \ + curlcheck_cb_compatible((expr), _curl_interleave_callback2)) +typedef size_t (*_curl_interleave_callback1)(void *p, size_t s, + size_t n, void *u); +typedef size_t (*_curl_interleave_callback2)(char *p, size_t s, + size_t n, void *u); + +/* evaluates to true if expr is of type curl_prereq_callback */ +#define curlcheck_prereq_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_prereq_callback)) + +/* evaluates to true if expr is of type curl_trailer_callback */ +#define curlcheck_trailer_cb(expr) \ + (curlcheck_NULL(expr) || \ + curlcheck_cb_compatible((expr), curl_trailer_callback)) + +#endif /* CURLINC_TYPECHECK_GCC_H */ diff --git a/curl-install/include/curl/urlapi.h b/curl-install/include/curl/urlapi.h new file mode 100644 index 00000000..b4a6e5d5 --- /dev/null +++ b/curl-install/include/curl/urlapi.h @@ -0,0 +1,155 @@ +#ifndef CURLINC_URLAPI_H +#define CURLINC_URLAPI_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#include "curl.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/* the error codes for the URL API */ +typedef enum { + CURLUE_OK, + CURLUE_BAD_HANDLE, /* 1 */ + CURLUE_BAD_PARTPOINTER, /* 2 */ + CURLUE_MALFORMED_INPUT, /* 3 */ + CURLUE_BAD_PORT_NUMBER, /* 4 */ + CURLUE_UNSUPPORTED_SCHEME, /* 5 */ + CURLUE_URLDECODE, /* 6 */ + CURLUE_OUT_OF_MEMORY, /* 7 */ + CURLUE_USER_NOT_ALLOWED, /* 8 */ + CURLUE_UNKNOWN_PART, /* 9 */ + CURLUE_NO_SCHEME, /* 10 */ + CURLUE_NO_USER, /* 11 */ + CURLUE_NO_PASSWORD, /* 12 */ + CURLUE_NO_OPTIONS, /* 13 */ + CURLUE_NO_HOST, /* 14 */ + CURLUE_NO_PORT, /* 15 */ + CURLUE_NO_QUERY, /* 16 */ + CURLUE_NO_FRAGMENT, /* 17 */ + CURLUE_NO_ZONEID, /* 18 */ + CURLUE_BAD_FILE_URL, /* 19 */ + CURLUE_BAD_FRAGMENT, /* 20 */ + CURLUE_BAD_HOSTNAME, /* 21 */ + CURLUE_BAD_IPV6, /* 22 */ + CURLUE_BAD_LOGIN, /* 23 */ + CURLUE_BAD_PASSWORD, /* 24 */ + CURLUE_BAD_PATH, /* 25 */ + CURLUE_BAD_QUERY, /* 26 */ + CURLUE_BAD_SCHEME, /* 27 */ + CURLUE_BAD_SLASHES, /* 28 */ + CURLUE_BAD_USER, /* 29 */ + CURLUE_LACKS_IDN, /* 30 */ + CURLUE_TOO_LARGE, /* 31 */ + CURLUE_LAST +} CURLUcode; + +typedef enum { + CURLUPART_URL, + CURLUPART_SCHEME, + CURLUPART_USER, + CURLUPART_PASSWORD, + CURLUPART_OPTIONS, + CURLUPART_HOST, + CURLUPART_PORT, + CURLUPART_PATH, + CURLUPART_QUERY, + CURLUPART_FRAGMENT, + CURLUPART_ZONEID /* added in 7.65.0 */ +} CURLUPart; + +#define CURLU_DEFAULT_PORT (1<<0) /* return default port number */ +#define CURLU_NO_DEFAULT_PORT (1<<1) /* act as if no port number was set, + if the port number matches the + default for the scheme */ +#define CURLU_DEFAULT_SCHEME (1<<2) /* return default scheme if + missing */ +#define CURLU_NON_SUPPORT_SCHEME (1<<3) /* allow non-supported scheme */ +#define CURLU_PATH_AS_IS (1<<4) /* leave dot sequences */ +#define CURLU_DISALLOW_USER (1<<5) /* no user+password allowed */ +#define CURLU_URLDECODE (1<<6) /* URL decode on get */ +#define CURLU_URLENCODE (1<<7) /* URL encode on set */ +#define CURLU_APPENDQUERY (1<<8) /* append a form style part */ +#define CURLU_GUESS_SCHEME (1<<9) /* legacy curl-style guessing */ +#define CURLU_NO_AUTHORITY (1<<10) /* Allow empty authority when the + scheme is unknown. */ +#define CURLU_ALLOW_SPACE (1<<11) /* Allow spaces in the URL */ +#define CURLU_PUNYCODE (1<<12) /* get the hostname in punycode */ +#define CURLU_PUNY2IDN (1<<13) /* punycode => IDN conversion */ +#define CURLU_GET_EMPTY (1<<14) /* allow empty queries and fragments + when extracting the URL or the + components */ +#define CURLU_NO_GUESS_SCHEME (1<<15) /* for get, do not accept a guess */ + +typedef struct Curl_URL CURLU; + +/* + * curl_url() creates a new CURLU handle and returns a pointer to it. + * Must be freed with curl_url_cleanup(). + */ +CURL_EXTERN CURLU *curl_url(void); + +/* + * curl_url_cleanup() frees the CURLU handle and related resources used for + * the URL parsing. It will not free strings previously returned with the URL + * API. + */ +CURL_EXTERN void curl_url_cleanup(CURLU *handle); + +/* + * curl_url_dup() duplicates a CURLU handle and returns a new copy. The new + * handle must also be freed with curl_url_cleanup(). + */ +CURL_EXTERN CURLU *curl_url_dup(const CURLU *in); + +/* + * curl_url_get() extracts a specific part of the URL from a CURLU + * handle. Returns error code. The returned pointer MUST be freed with + * curl_free() afterwards. + */ +CURL_EXTERN CURLUcode curl_url_get(const CURLU *handle, CURLUPart what, + char **part, unsigned int flags); + +/* + * curl_url_set() sets a specific part of the URL in a CURLU handle. Returns + * error code. The passed in string will be copied. Passing a NULL instead of + * a part string, clears that part. + */ +CURL_EXTERN CURLUcode curl_url_set(CURLU *handle, CURLUPart what, + const char *part, unsigned int flags); + +/* + * curl_url_strerror() turns a CURLUcode value into the equivalent human + * readable error string. This is useful for printing meaningful error + * messages. + */ +CURL_EXTERN const char *curl_url_strerror(CURLUcode); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif /* CURLINC_URLAPI_H */ diff --git a/curl-install/include/curl/websockets.h b/curl-install/include/curl/websockets.h new file mode 100644 index 00000000..afb86b4e --- /dev/null +++ b/curl-install/include/curl/websockets.h @@ -0,0 +1,85 @@ +#ifndef CURLINC_WEBSOCKETS_H +#define CURLINC_WEBSOCKETS_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at https://curl.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + * SPDX-License-Identifier: curl + * + ***************************************************************************/ + +#ifdef __cplusplus +extern "C" { +#endif + +struct curl_ws_frame { + int age; /* zero */ + int flags; /* See the CURLWS_* defines */ + curl_off_t offset; /* the offset of this data into the frame */ + curl_off_t bytesleft; /* number of pending bytes left of the payload */ + size_t len; /* size of the current data chunk */ +}; + +/* flag bits */ +#define CURLWS_TEXT (1<<0) +#define CURLWS_BINARY (1<<1) +#define CURLWS_CONT (1<<2) +#define CURLWS_CLOSE (1<<3) +#define CURLWS_PING (1<<4) +#define CURLWS_OFFSET (1<<5) + +/* + * NAME curl_ws_recv() + * + * DESCRIPTION + * + * Receives data from the websocket connection. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_ws_recv(CURL *curl, void *buffer, size_t buflen, + size_t *recv, + const struct curl_ws_frame **metap); + +/* flags for curl_ws_send() */ +#define CURLWS_PONG (1<<6) + +/* + * NAME curl_ws_send() + * + * DESCRIPTION + * + * Sends data over the websocket connection. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_ws_send(CURL *curl, const void *buffer, + size_t buflen, size_t *sent, + curl_off_t fragsize, + unsigned int flags); + +/* bits for the CURLOPT_WS_OPTIONS bitmask: */ +#define CURLWS_RAW_MODE (1<<0) +#define CURLWS_NOAUTOPONG (1<<1) + +CURL_EXTERN const struct curl_ws_frame *curl_ws_meta(CURL *curl); + +#ifdef __cplusplus +} +#endif + +#endif /* CURLINC_WEBSOCKETS_H */ diff --git a/curl-install/lib/libcurl.la b/curl-install/lib/libcurl.la new file mode 100755 index 00000000..fb8da40e --- /dev/null +++ b/curl-install/lib/libcurl.la @@ -0,0 +1,41 @@ +# libcurl.la - a libtool library file +# Generated by libtool (GNU libtool) 2.4.7 Debian-2.4.7-7~deb12u1 +# +# Please DO NOT delete this file! +# It is necessary for linking the library. + +# The name that we can dlopen(3). +dlname='' + +# Names of this library. +library_names='' + +# The name of the static archive. +old_library='libcurl.a' + +# Linker flags that cannot go in dependency_libs. +inherited_linker_flags='' + +# Libraries that this one depends upon. +dependency_libs=' -lssl -lcrypto -lz -L/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/openssl-3.4.2/../openssl-install/lib64' + +# Names of additional weak libraries provided by this library +weak_library_names='' + +# Version information for libcurl. +current=12 +age=8 +revision=0 + +# Is this an already installed library? +installed=yes + +# Should we warn about portability when linking against -modules? +shouldnotlink=no + +# Files to dlopen/dlpreopen +dlopen='' +dlpreopen='' + +# Directory that this library needs to be installed in: +libdir='/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/curl-install/lib' diff --git a/curl-install/lib/pkgconfig/libcurl.pc b/curl-install/lib/pkgconfig/libcurl.pc new file mode 100644 index 00000000..d7e2699d --- /dev/null +++ b/curl-install/lib/pkgconfig/libcurl.pc @@ -0,0 +1,41 @@ +#*************************************************************************** +# _ _ ____ _ +# Project ___| | | | _ \| | +# / __| | | | |_) | | +# | (__| |_| | _ <| |___ +# \___|\___/|_| \_\_____| +# +# Copyright (C) Daniel Stenberg, , et al. +# +# This software is licensed as described in the file COPYING, which +# you should have received as part of this distribution. The terms +# are also available at https://curl.se/docs/copyright.html. +# +# You may opt to use, copy, modify, merge, publish, distribute and/or sell +# copies of the Software, and permit persons to whom the Software is +# furnished to do so, under the terms of the COPYING file. +# +# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +# KIND, either express or implied. +# +# SPDX-License-Identifier: curl +# +########################################################################### + +prefix=/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/curl-install +exec_prefix=${prefix} +libdir=${exec_prefix}/lib +includedir=${prefix}/include +supported_protocols="FILE FTP FTPS HTTP HTTPS IPFS IPNS MQTT WS WSS" +supported_features="alt-svc AsynchDNS HSTS IPv6 Largefile libz NTLM SSL threadsafe TLS-SRP UnixSockets" + +Name: libcurl +URL: https://curl.se/ +Description: Library to transfer files with HTTP, FTP, etc. +Version: 8.15.0 +Requires: zlib,openssl +Requires.private: zlib,openssl +Libs: -L${libdir} -lcurl -lssl -lcrypto -lssl -lcrypto -lz +Libs.private: -L/home/teknari/Sync/Programming/VibeCoding/nostr_core_lib/openssl-3.4.2/../openssl-install/lib64 -lssl -lcrypto -lssl -lcrypto -lz +Cflags: -I${includedir} -DCURL_STATICLIB +Cflags.private: -DCURL_STATICLIB diff --git a/curl-install/share/aclocal/libcurl.m4 b/curl-install/share/aclocal/libcurl.m4 new file mode 100644 index 00000000..e89ab31d --- /dev/null +++ b/curl-install/share/aclocal/libcurl.m4 @@ -0,0 +1,273 @@ +#*************************************************************************** +# _ _ ____ _ +# Project ___| | | | _ \| | +# / __| | | | |_) | | +# | (__| |_| | _ <| |___ +# \___|\___/|_| \_\_____| +# +# Copyright (C) David Shaw +# +# This software is licensed as described in the file COPYING, which +# you should have received as part of this distribution. The terms +# are also available at https://curl.se/docs/copyright.html. +# +# You may opt to use, copy, modify, merge, publish, distribute and/or sell +# copies of the Software, and permit persons to whom the Software is +# furnished to do so, under the terms of the COPYING file. +# +# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +# KIND, either express or implied. +# +# SPDX-License-Identifier: curl +# +########################################################################### +# LIBCURL_CHECK_CONFIG([DEFAULT-ACTION], [MINIMUM-VERSION], +# [ACTION-IF-YES], [ACTION-IF-NO]) +# ---------------------------------------------------------- +# David Shaw May-09-2006 +# +# Checks for libcurl. DEFAULT-ACTION is the string yes or no to +# specify whether to default to --with-libcurl or --without-libcurl. +# If not supplied, DEFAULT-ACTION is yes. MINIMUM-VERSION is the +# minimum version of libcurl to accept. Pass the version as a regular +# version number like 7.10.1. If not supplied, any version is +# accepted. ACTION-IF-YES is a list of shell commands to run if +# libcurl was successfully found and passed the various tests. +# ACTION-IF-NO is a list of shell commands that are run otherwise. +# Note that using --without-libcurl does run ACTION-IF-NO. +# +# This macro #defines HAVE_LIBCURL if a working libcurl setup is +# found, and sets @LIBCURL@ and @LIBCURL_CPPFLAGS@ to the necessary +# values. Other useful defines are LIBCURL_FEATURE_xxx where xxx are +# the various features supported by libcurl, and LIBCURL_PROTOCOL_yyy +# where yyy are the various protocols supported by libcurl. Both xxx +# and yyy are capitalized. See the list of AH_TEMPLATEs at the top of +# the macro for the complete list of possible defines. Shell +# variables $libcurl_feature_xxx and $libcurl_protocol_yyy are also +# defined to 'yes' for those features and protocols that were found. +# Note that xxx and yyy keep the same capitalization as in the +# curl-config list (e.g. it's "HTTP" and not "http"). +# +# Users may override the detected values by doing something like: +# LIBCURL="-lcurl" LIBCURL_CPPFLAGS="-I/usr/myinclude" ./configure +# +# For the sake of sanity, this macro assumes that any libcurl that is found is +# after version 7.7.2, the first version that included the curl-config script. +# Note that it is important for people packaging binary versions of libcurl to +# include this script! Without curl-config, we can only guess what protocols +# are available, or use curl_version_info to figure it out at runtime. + +AC_DEFUN([LIBCURL_CHECK_CONFIG], +[ + AH_TEMPLATE([LIBCURL_FEATURE_SSL],[Defined if libcurl supports SSL]) + AH_TEMPLATE([LIBCURL_FEATURE_KRB4],[Defined if libcurl supports KRB4]) + AH_TEMPLATE([LIBCURL_FEATURE_IPV6],[Defined if libcurl supports IPv6]) + AH_TEMPLATE([LIBCURL_FEATURE_LIBZ],[Defined if libcurl supports libz]) + AH_TEMPLATE([LIBCURL_FEATURE_ASYNCHDNS],[Defined if libcurl supports AsynchDNS]) + AH_TEMPLATE([LIBCURL_FEATURE_IDN],[Defined if libcurl supports IDN]) + AH_TEMPLATE([LIBCURL_FEATURE_SSPI],[Defined if libcurl supports SSPI]) + AH_TEMPLATE([LIBCURL_FEATURE_NTLM],[Defined if libcurl supports NTLM]) + + AH_TEMPLATE([LIBCURL_PROTOCOL_HTTP],[Defined if libcurl supports HTTP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_HTTPS],[Defined if libcurl supports HTTPS]) + AH_TEMPLATE([LIBCURL_PROTOCOL_FTP],[Defined if libcurl supports FTP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_FTPS],[Defined if libcurl supports FTPS]) + AH_TEMPLATE([LIBCURL_PROTOCOL_FILE],[Defined if libcurl supports FILE]) + AH_TEMPLATE([LIBCURL_PROTOCOL_TELNET],[Defined if libcurl supports TELNET]) + AH_TEMPLATE([LIBCURL_PROTOCOL_LDAP],[Defined if libcurl supports LDAP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_DICT],[Defined if libcurl supports DICT]) + AH_TEMPLATE([LIBCURL_PROTOCOL_TFTP],[Defined if libcurl supports TFTP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_RTSP],[Defined if libcurl supports RTSP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_POP3],[Defined if libcurl supports POP3]) + AH_TEMPLATE([LIBCURL_PROTOCOL_IMAP],[Defined if libcurl supports IMAP]) + AH_TEMPLATE([LIBCURL_PROTOCOL_SMTP],[Defined if libcurl supports SMTP]) + + AC_ARG_WITH(libcurl, + AS_HELP_STRING([--with-libcurl=PREFIX],[look for the curl library in PREFIX/lib and headers in PREFIX/include]), + [_libcurl_with=$withval],[_libcurl_with=ifelse([$1],,[yes],[$1])]) + + if test "$_libcurl_with" != "no"; then + + AC_PROG_AWK + + _libcurl_version_parse="eval $AWK '{split(\$NF,A,\".\"); X=256*256*A[[1]]+256*A[[2]]+A[[3]]; print X;}'" + + _libcurl_try_link=yes + + if test -d "$_libcurl_with"; then + LIBCURL_CPPFLAGS="-I$withval/include" + _libcurl_ldflags="-L$withval/lib" + AC_PATH_PROG([_libcurl_config],[curl-config],[],["$withval/bin"]) + else + AC_PATH_PROG([_libcurl_config],[curl-config],[],[$PATH]) + fi + + if test x$_libcurl_config != "x"; then + AC_CACHE_CHECK([for the version of libcurl], + [libcurl_cv_lib_curl_version], + [libcurl_cv_lib_curl_version=`$_libcurl_config --version | $AWK '{print $[]2}'`]) + + _libcurl_version=`echo $libcurl_cv_lib_curl_version | $_libcurl_version_parse` + _libcurl_wanted=`echo ifelse([$2],,[0],[$2]) | $_libcurl_version_parse` + + if test $_libcurl_wanted -gt 0; then + AC_CACHE_CHECK([for libcurl >= version $2], + [libcurl_cv_lib_version_ok], + [ + if test $_libcurl_version -ge $_libcurl_wanted; then + libcurl_cv_lib_version_ok=yes + else + libcurl_cv_lib_version_ok=no + fi + ]) + fi + + if test $_libcurl_wanted -eq 0 || test x$libcurl_cv_lib_version_ok = xyes; then + if test x"$LIBCURL_CPPFLAGS" = "x"; then + LIBCURL_CPPFLAGS=`$_libcurl_config --cflags` + fi + if test x"$LIBCURL" = "x"; then + LIBCURL=`$_libcurl_config --libs` + + # This is so silly, but Apple actually has a bug in their + # curl-config script. Fixed in Tiger, but there are still + # lots of Panther installs around. + case "${host}" in + powerpc-apple-darwin7*) + LIBCURL=`echo $LIBCURL | sed -e 's|-arch i386||g'` + ;; + esac + fi + + # All curl-config scripts support --feature + _libcurl_features=`$_libcurl_config --feature` + + # Is it modern enough to have --protocols? (7.12.4) + if test $_libcurl_version -ge 461828; then + _libcurl_protocols=`$_libcurl_config --protocols` + fi + else + _libcurl_try_link=no + fi + + unset _libcurl_wanted + fi + + if test $_libcurl_try_link = yes; then + + # we did not find curl-config, so let's see if the user-supplied + # link line (or failing that, "-lcurl") is enough. + LIBCURL=${LIBCURL-"$_libcurl_ldflags -lcurl"} + + AC_CACHE_CHECK([whether libcurl is usable], + [libcurl_cv_lib_curl_usable], + [ + _libcurl_save_cppflags=$CPPFLAGS + CPPFLAGS="$LIBCURL_CPPFLAGS $CPPFLAGS" + _libcurl_save_libs=$LIBS + LIBS="$LIBCURL $LIBS" + + AC_LINK_IFELSE([AC_LANG_PROGRAM([[#include ]],[[ + /* Try to use a few common options to force a failure if we are + missing symbols or cannot link. */ + int x; + curl_easy_setopt(NULL,CURLOPT_URL,NULL); + x=CURL_ERROR_SIZE; + x=CURLOPT_WRITEFUNCTION; + x=CURLOPT_WRITEDATA; + x=CURLOPT_ERRORBUFFER; + x=CURLOPT_STDERR; + x=CURLOPT_VERBOSE; + if (x) {;} + ]])],libcurl_cv_lib_curl_usable=yes,libcurl_cv_lib_curl_usable=no) + + CPPFLAGS=$_libcurl_save_cppflags + LIBS=$_libcurl_save_libs + unset _libcurl_save_cppflags + unset _libcurl_save_libs + ]) + + if test $libcurl_cv_lib_curl_usable = yes; then + + # Does curl_free() exist in this version of libcurl? + # If not, fake it with free() + + _libcurl_save_cppflags=$CPPFLAGS + CPPFLAGS="$CPPFLAGS $LIBCURL_CPPFLAGS" + _libcurl_save_libs=$LIBS + LIBS="$LIBS $LIBCURL" + + AC_CHECK_DECL([curl_free],[], + [AC_DEFINE([curl_free],[free], + [Define curl_free() as free() if our version of curl lacks curl_free.])], + [[#include ]]) + + CPPFLAGS=$_libcurl_save_cppflags + LIBS=$_libcurl_save_libs + unset _libcurl_save_cppflags + unset _libcurl_save_libs + + AC_DEFINE(HAVE_LIBCURL,1, + [Define to 1 if you have a functional curl library.]) + AC_SUBST(LIBCURL_CPPFLAGS) + AC_SUBST(LIBCURL) + + for _libcurl_feature in $_libcurl_features; do + AC_DEFINE_UNQUOTED(AS_TR_CPP(libcurl_feature_$_libcurl_feature),[1]) + eval AS_TR_SH(libcurl_feature_$_libcurl_feature)=yes + done + + if test "x$_libcurl_protocols" = "x"; then + + # We do not have --protocols, so just assume that all + # protocols are available + _libcurl_protocols="HTTP FTP FILE TELNET LDAP DICT TFTP" + + if test x$libcurl_feature_SSL = xyes; then + _libcurl_protocols="$_libcurl_protocols HTTPS" + + # FTPS was not standards-compliant until version + # 7.11.0 (0x070b00 == 461568) + if test $_libcurl_version -ge 461568; then + _libcurl_protocols="$_libcurl_protocols FTPS" + fi + fi + + # RTSP, IMAP, POP3 and SMTP were added in + # 7.20.0 (0x071400 == 463872) + if test $_libcurl_version -ge 463872; then + _libcurl_protocols="$_libcurl_protocols RTSP IMAP POP3 SMTP" + fi + fi + + for _libcurl_protocol in $_libcurl_protocols; do + AC_DEFINE_UNQUOTED(AS_TR_CPP(libcurl_protocol_$_libcurl_protocol),[1]) + eval AS_TR_SH(libcurl_protocol_$_libcurl_protocol)=yes + done + else + unset LIBCURL + unset LIBCURL_CPPFLAGS + fi + fi + + unset _libcurl_try_link + unset _libcurl_version_parse + unset _libcurl_config + unset _libcurl_feature + unset _libcurl_features + unset _libcurl_protocol + unset _libcurl_protocols + unset _libcurl_version + unset _libcurl_ldflags + fi + + if test x$_libcurl_with = xno || test x$libcurl_cv_lib_curl_usable != xyes; then + # This is the IF-NO path + ifelse([$4],,:,[$4]) + else + # This is the IF-YES path + ifelse([$3],,:,[$3]) + fi + + unset _libcurl_with +]) diff --git a/curl-install/share/man/man1/curl-config.1 b/curl-install/share/man/man1/curl-config.1 new file mode 100644 index 00000000..99cd80ef --- /dev/null +++ b/curl-install/share/man/man1/curl-config.1 @@ -0,0 +1,90 @@ +.\" generated by cd2nroff 0.1 from curl-config.md +.TH curl-config 1 "2025-08-14" curl-config +.SH NAME +curl\-config \- Get information about a libcurl installation +.SH SYNOPSIS +\fBcurl\-config [options]\fP +.SH DESCRIPTION +\fBcurl\-config\fP +displays information about the curl and libcurl installation. +.SH OPTIONS +.IP --ca +Displays the built\-in path to the CA cert bundle this libcurl uses. +.IP --cc +Displays the compiler used to build libcurl. +.IP --cflags +Set of compiler options (CFLAGS) to use when compiling files that use +libcurl. Currently that is only the include path to the curl include files. +.IP "--checkfor [version]" +Specify the oldest possible libcurl version string you want, and this script +returns 0 if the current installation is new enough or it returns 1 and +outputs a text saying that the current version is not new enough. (Added in +7.15.4) +.IP --configure +Displays the arguments given to configure when building curl. +.IP --feature +Lists what particular main features the installed libcurl was built with. At +the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume +any particular order. The keywords are separated by newlines. There may be +none, one, or several keywords in the list. +.IP --help +Displays the available options. +.IP --libs +Shows the complete set of libs and other linker options you need in order to +link your application with libcurl. +.IP --prefix +This is the prefix used when libcurl was installed. libcurl is then installed +in $prefix/lib and its header files are installed in $prefix/include and so +on. The prefix is set with \fIconfigure \--prefix\fP. +.IP --protocols +Lists what particular protocols the installed libcurl was built to support. At +the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE, +TELNET, LDAP, DICT and many more. Do not assume any particular order. The +protocols are listed using uppercase and are separated by newlines. There may +be none, one, or several protocols in the list. (Added in 7.13.0) +.IP --ssl-backends +Lists the SSL backends that were enabled when libcurl was built. It might be +no, one or several names. If more than one name, they appear comma\-separated. +(Added in 7.58.0) +.IP --static-libs +Shows the complete set of libs and other linker options you need in order to +link your application with libcurl statically. (Added in 7.17.1) +.IP --version +Outputs version information about the installed libcurl. +.IP --vernum +Outputs version information about the installed libcurl, in numerical mode. +This shows the version number, in hexadecimal, using 8 bits for each part: +major, minor, and patch numbers. This makes libcurl 7.7.4 appear as 070704 and +libcurl 12.13.14 appear as 0c0d0e... Note that the initial zero might be +omitted. (This option was broken in the 7.15.0 release.) +.SH EXAMPLES +What linker options do I need when I link with libcurl? + +.nf +$ curl-config --libs +.fi + +What compiler options do I need when I compile using libcurl functions? + +.nf +$ curl-config --cflags +.fi + +How do I know if libcurl was built with SSL support? + +.nf +$ curl-config --feature | grep SSL +.fi + +What\(aqs the installed libcurl version? + +.nf +$ curl-config --version +.fi + +How do I build a single file with a one\-line command? + +.nf +$ `curl-config --cc --cflags` -o example source.c `curl-config --libs` +.SH SEE ALSO +.BR curl (1) diff --git a/curl-install/share/man/man1/curl.1 b/curl-install/share/man/man1/curl.1 new file mode 100644 index 00000000..56fbae80 --- /dev/null +++ b/curl-install/share/man/man1/curl.1 @@ -0,0 +1,6809 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) Daniel Stenberg, , et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" * SPDX-License-Identifier: curl +.\" * +.\" ************************************************************************** +.\" +.\" DO NOT EDIT. Generated by the curl project managen manpage generator. +.\" +.TH curl 1 "2025-08-14" "curl 8.15.0" "curl Manual" +.SH NAME +curl \- transfer a URL +.SH SYNOPSIS +\fBcurl [options / URLs]\fP +.SH DESCRIPTION +\fBcurl\fP is a tool for transferring data from or to a server using URLs. It +supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, +IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, +SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. + +curl is powered by libcurl for all transfer\-related features. See +\fIlibcurl(3)\fP for details. +.SH URL +The URL syntax is protocol\-dependent. You find a detailed description in +RFC 3986. + +If you provide a URL without a leading \fBprotocol://\fP scheme, curl guesses +what protocol you want. It then defaults to HTTP but assumes others based on +often\-used hostname prefixes. For example, for hostnames starting with "ftp." +curl assumes you want FTP. + +You can specify any amount of URLs on the command line. They are fetched in a +sequential manner in the specified order unless you use \fI\-Z, \-\-parallel\fP. You can +specify command line options and URLs mixed and in any order on the command +line. + +curl attempts to reuse connections when doing multiple transfers, so that +getting many files from the same server do not use multiple connects and setup +handshakes. This improves speed. Connection reuse can only be done for URLs +specified for a single command line invocation and cannot be performed between +separate curl runs. + +Provide an IPv6 zone id in the URL with an escaped percentage sign. Like in + +.nf +\&"http://[fe80::3%25eth0]/" +.fi + +Everything provided on the command line that is not a command line option or +its argument, curl assumes is a URL and treats it as such. +.SH GLOBBING +You can specify multiple URLs or parts of URLs by writing lists within braces +or ranges within brackets. We call this "globbing". + +Provide a list with three different names like this: + +.nf +\&"http://site.{one,two,three}.com" +.fi + +Do sequences of alphanumeric series by using [] as in: + +.nf +\&"ftp://ftp.example.com/file[1\-100].txt" +.fi + +With leading zeroes: + +.nf +\&"ftp://ftp.example.com/file[001\-100].txt" +.fi + +With letters through the alphabet: + +.nf +\&"ftp://ftp.example.com/file[a\-z].txt" +.fi + +Nested sequences are not supported, but you can use several ones next to each +other: + +.nf +\&"http://example.com/archive[1996\-1999]/vol[1\-4]/part{a,b,c}.html" +.fi + +You can specify a step counter for the ranges to get every Nth number or +letter: + +.nf +\&"http://example.com/file[1\-100:10].txt" + +\&"http://example.com/file[a\-z:2].txt" +.fi + +When using [] or {} sequences when invoked from a command line prompt, you +probably have to put the full URL within double quotes to avoid the shell from +interfering with it. This also goes for other characters treated special, like +for example \(aq&\(aq, \(aq?\(aq and \(aq*\(aq. + +Switch off globbing with \fI\-g, \-\-globoff\fP. +.SH VARIABLES +curl supports command line variables (added in 8.3.0). Set variables with +\fI\-\-variable\fP name=content or \fI\-\-variable\fP name@file (where "file" can be stdin if +set to a single dash (\-)). + +Variable contents can be expanded in option parameters using "{{name}}" if the +option name is prefixed with "\fI\-\-expand\-\fP". This gets the contents of the +variable "name" inserted, or a blank if the name does not exist as a +variable. Insert "{{" verbatim in the string by prefixing it with a backslash, +like "\\{{". + +You access and expand environment variables by first importing them. You +select to either require the environment variable to be set or you can provide +a default value in case it is not already set. Plain "\fI\-\-variable\fP %name" +imports the variable called "name" but exits with an error if that environment +variable is not already set. To provide a default value if it is not set, use +\&"\fI\-\-variable\fP %name=content" or "\fI\-\-variable\fP %name@content". + +Example. Get the USER environment variable into the URL, fail if USER is not +set: + +.nf +-\-variable \(aq%USER\(aq +-\-expand\-url = "https://example.com/api/{{USER}}/method" +.fi + +When expanding variables, curl supports a set of functions that can make the +variable contents more convenient to use. It can trim leading and trailing +white space with "trim", it can output the contents as a JSON quoted string +with "json", URL encode the string with "url", base64 encode it with "b64" and +base64 decode it with "64dec". To apply functions to a variable expansion, add +them colon separated to the right side of the variable. Variable content +holding null bytes that are not encoded when expanded causes an error. + +Example: get the contents of a file called $HOME/.secret into a variable +called "fix". Make sure that the content is trimmed and percent\-encoded when +sent as POST data: + +.nf +-\-variable %HOME +-\-expand\-variable fix@{{HOME}}/.secret +-\-expand\-data "{{fix:trim:url}}" +https://example.com/ +.fi + +Command line variables and expansions were added in 8.3.0. +.SH OUTPUT +If not told otherwise, curl writes the received data to stdout. It can be +instructed to instead save that data into a local file, using the \fI\-o, \-\-output\fP or +\fI\-O, \-\-remote\-name\fP options. If curl is given multiple URLs to transfer on the +command line, it similarly needs multiple options for where to save them. + +curl does not parse or otherwise "understand" the content it gets or writes as +output. It does no encoding or decoding, unless explicitly asked to with +dedicated command line options. +.SH PROTOCOLS +curl supports numerous protocols, or put in URL terms: schemes. Your +particular build may not support them all. +.IP DICT +Lets you lookup words using online dictionaries. +.IP FILE +Read or write local files. curl does not support accessing file:// URL +remotely, but when running on Microsoft Windows using the native UNC approach +works. +.IP FTP(S) +curl supports the File Transfer Protocol with a lot of tweaks and levers. With +or without using TLS. +.IP GOPHER(S) +Retrieve files. +.IP HTTP(S) +curl supports HTTP with numerous options and variations. It can speak HTTP +version 0.9, 1.0, 1.1, 2 and 3 depending on build options and the correct +command line options. +.IP IMAP(S) +Using the mail reading protocol, curl can download emails for you. With or +without using TLS. +.IP LDAP(S) +curl can do directory lookups for you, with or without TLS. +.IP MQTT +curl supports MQTT version 3. Downloading over MQTT equals subscribing to a +topic while uploading/posting equals publishing on a topic. MQTT over TLS is not +supported (yet). +.IP POP3(S) +Downloading from a pop3 server means getting an email. With or without using +TLS. +.IP RTMP(S) +The \fBRealtime Messaging Protocol\fP is primarily used to serve streaming media +and curl can download it. +.IP RTSP +curl supports RTSP 1.0 downloads. +.IP SCP +curl supports SSH version 2 scp transfers. +.IP SFTP +curl supports SFTP (draft 5) done over SSH version 2. +.IP SMB(S) +curl supports SMB version 1 for upload and download. +.IP SMTP(S) +Uploading contents to an SMTP server means sending an email. With or without +TLS. +.IP TELNET +Fetching a telnet URL starts an interactive session where it sends what it +reads on stdin and outputs what the server sends it. +.IP TFTP +curl can do TFTP downloads and uploads. +.IP WS(S) +WebSocket done over HTTP/1. WSS implies that it works over HTTPS. +.SH PROGRESS METER +curl normally displays a progress meter during operations, indicating the +amount of transferred data, transfer speeds and estimated time left, etc. The +progress meter displays the transfer rate in bytes per second. The suffixes +(k, M, G, T, P) are 1024 based. For example 1k is 1024 bytes. 1M is 1048576 +bytes. + +curl displays this data to the terminal by default, so if you invoke curl to +do an operation and it is about to write data to the terminal, it \fIdisables\fP +the progress meter as otherwise it would mess up the output mixing progress +meter and response data. + +If you want a progress meter for HTTP POST or PUT requests, you need to +redirect the response output to a file, using shell redirect (>), \fI\-o, \-\-output\fP +or similar. + +This does not apply to FTP upload as that operation does not spit out any +response data to the terminal. + +If you prefer a progress bar instead of the regular meter, \fI\-#, \-\-progress\-bar\fP is +your friend. You can also disable the progress meter completely with the +\fI\-s, \-\-silent\fP option. +.SH VERSION +This man page describes curl 8.15.0. If you use a later version, chances +are this man page does not fully document it. If you use an earlier version, +this document tries to include version information about which specific +version that introduced changes. + +You can always learn which the latest curl version is by running + +.nf +curl https://curl.se/info +.fi + +The online version of this man page is always showing the latest incarnation: +https://curl.se/docs/manpage.html +.SH OPTIONS +Options start with one or two dashes. Many of the options require an +additional value next to them. If provided text does not start with a dash, it +is presumed to be and treated as a URL. + +The short "single\-dash" form of the options, \-d for example, may be used with +or without a space between it and its value, although a space is a recommended +separator. The long double\-dash form, \fI\-d, \-\-data\fP for example, requires a space +between it and its value. + +Short version options that do not need any additional values can be used +immediately next to each other, like for example you can specify all the +options \fI\-O\fP, \fI\-L\fP and \fI\-v\fP at once as \fI\-OLv\fP. + +In general, all boolean options are enabled with \--\fBoption\fP and yet again +disabled with \--\fBno\-\fPoption. That is, you use the same option name but +prefix it with "no\-". However, in this list we mostly only list and show the +-\-\fBoption\fP version of them. + +When \fI\-:, \-\-next\fP is used, it resets the parser state and you start again with a +clean option state, except for the options that are global. Global options +retain their values and meaning even after \fI\-:, \-\-next\fP. + +The first argument that is exactly two dashes ("\--"), marks the end of +options; any argument after the end of options is interpreted as a URL +argument even if it starts with a dash. + +curl does little to no verification of the contents of command line arguments. +Passing in "creative octets" like newlines might trigger unexpected results. + +The following options are global: \fI\-\-fail\-early\fP, \fI\-\-libcurl\fP, \fI\-\-parallel\-immediate\fP, \fI\-\-parallel\-max\fP, \fI\-Z, \-\-parallel\fP, \fI\-#, \-\-progress\-bar\fP, \fI\-\-rate\fP, \fI\-S, \-\-show\-error\fP, \fI\-\-stderr\fP, \fI\-\-styled\-output\fP, \fI\-\-trace\-ascii\fP, \fI\-\-trace\-config\fP, \fI\-\-trace\-ids\fP, \fI\-\-trace\-time\fP, \fI\-\-trace\fP and \fI\-v, \-\-verbose\fP. +.SH ALL OPTIONS +.IP "\-\-abstract\-unix\-socket " +(HTTP) Connect through an abstract Unix domain socket, instead of using the network. +Note: netstat shows the path of an abstract socket prefixed with "@", however +the argument should not have this leading character. + +If --abstract-unix-socket is provided several times, the last set value is used. + +Example: +.nf +curl --abstract-unix-socket socketpath https://example.com +.fi + +See also \fI\-\-unix\-socket\fP. +.IP "\-\-alt\-svc " +(HTTPS) Enable the alt\-svc parser. If the filename points to an existing alt\-svc cache +file, that gets used. After a completed transfer, the cache is saved to the +filename again if it has been modified. + +Specify a "" filename (zero length) to avoid loading/saving and make curl just +handle the cache in memory. + +If this option is used several times, curl loads contents from all the +files but the last one is used for saving. + +--alt-svc can be used several times in a command line + +Example: +.nf +curl --alt-svc svc.txt https://example.com +.fi + +Added in 7.64.1. See also \fI\-\-resolve\fP and \fI\-\-connect\-to\fP. +.IP "\-\-anyauth" +(HTTP) Figure out authentication method automatically, and use the most secure one +the remote site claims to support. This is done by first doing a request and +checking the response\-headers, thus possibly inducing an extra network +round\-trip. This option is used instead of setting a specific authentication +method, which you can do with \fI\-\-basic\fP, \fI\-\-digest\fP, \fI\-\-ntlm\fP, and \fI\-\-negotiate\fP. + +Using \fI\-\-anyauth\fP is not recommended if you do uploads from stdin, since it may +require data to be sent twice and then the client must be able to rewind. If +the need should arise when uploading from stdin, the upload operation fails. + +Used together with \fI\-u, \-\-user\fP. + +Providing --anyauth multiple times has no extra effect. + +Example: +.nf +curl --anyauth --user me:pwd https://example.com +.fi + +See also \fI\-\-proxy\-anyauth\fP, \fI\-\-basic\fP and \fI\-\-digest\fP. +.IP "\-a, \-\-append" +(FTP SFTP) When used in an upload, this option makes curl append to the target file +instead of overwriting it. If the remote file does not exist, it is +created. Note that this flag is ignored by some SFTP servers (including +OpenSSH). + +Providing --append multiple times has no extra effect. +Disable it again with \-\-no-append. + +Example: +.nf +curl --upload-file local --append ftp://example.com/ +.fi + +See also \fI-r, \-\-range\fP and \fI-C, \-\-continue\-at\fP. +.IP "\-\-aws\-sigv4 " +(HTTP) Use AWS V4 signature authentication in the transfer. + +The provider argument is a string that is used by the algorithm when creating +outgoing authentication headers. + +The region argument is a string that points to a geographic area of +a resources collection (region\-code) when the region name is omitted from +the endpoint. + +The service argument is a string that points to a function provided by a cloud +(service\-code) when the service name is omitted from the endpoint. + +If --aws-sigv4 is provided several times, the last set value is used. + +Example: +.nf +curl --aws-sigv4 "aws:amz:us-east-2:es" --user "key:secret" https://example.com +.fi + +Added in 7.75.0. See also \fI\-\-basic\fP and \fI-u, \-\-user\fP. +.IP "\-\-basic" +(HTTP) Use HTTP Basic authentication with the remote host. This method is the default +and this option is usually pointless, unless you use it to override a +previously set option that sets a different authentication method (such as +\fI\-\-ntlm\fP, \fI\-\-digest\fP, or \fI\-\-negotiate\fP). + +Used together with \fI\-u, \-\-user\fP. + +Providing --basic multiple times has no extra effect. + +Example: +.nf +curl -u name:password --basic https://example.com +.fi + +See also \fI\-\-proxy\-basic\fP. +.IP "\-\-ca\-native" +(TLS) Use the operating system\(aqs native CA store for certificate verification. + +This option is independent of other CA certificate locations set at run time or +build time. Those locations are searched in addition to the native CA store. + +This option works with OpenSSL and its forks (LibreSSL, BoringSSL, etc) on +Windows. (Added in 7.71.0) + +This option works with wolfSSL on Windows, Linux (Debian, Ubuntu, Gentoo, +Fedora, RHEL), macOS, Android and iOS. (Added in 8.3.0) + +This option works with GnuTLS. (Added in 8.5.0) + +This option works with rustls on Windows, macOS, Android and iOS. On Linux it +is equivalent to using the Mozilla CA certificate bundle. When used with rustls +_only_ the native CA store is consulted, not other locations set at run time or +build time. (Added in 8.13.0) + +This option currently has no effect for Schannel. This is the native TLS +library from Microsoft, that by default uses the native CA store for +verification unless overridden by a CA certificate location setting. + +Providing --ca-native multiple times has no extra effect. +Disable it again with \-\-no-ca-native. + +Example: +.nf +curl --ca-native https://example.com +.fi + +Added in 8.2.0. See also \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP, \fI-k, \-\-insecure\fP and \fI\-\-proxy\-ca\-native\fP. +.IP "\-\-cacert " +(TLS) Use the specified certificate file to verify the peer. The file may contain +multiple CA certificates. The certificate(s) must be in PEM format. Normally +curl is built to use a default file for this, so this option is typically used +to alter that default file. + +curl recognizes the environment variable named \(aqCURL_CA_BUNDLE\(aq if it is set +and the TLS backend is not Schannel, and uses the given path as a path to a CA +cert bundle. This option overrides that variable. + +(Windows) curl automatically looks for a CA certs file named +\(aqcurl\-ca\-bundle.crt\(aq, either in the same directory as curl.exe, or in the +Current Working Directory, or in any folder along your PATH. + +curl 8.11.0 added a build\-time option to disable this search behavior, and +another option to restrict search to the application\(aqs directory. + +(Schannel) This option is supported for Schannel in Windows 7 or later (added +in 7.60.0). This option is supported for backward compatibility with other SSL +engines; instead it is recommended to use Windows\(aq store of root certificates +(the default for Schannel). + +If --cacert is provided several times, the last set value is used. + +Example: +.nf +curl --cacert CA-file.txt https://example.com +.fi + +See also \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-capath " +(TLS) Use the specified certificate directory to verify the peer. If curl is built against +OpenSSL, multiple paths can be provided by separating them with the appropriate platform\-specific +separator (e.g. "path1:path2:path3" on Unix\-style platforms for "path1;path2;path3" on Windows). + +The certificates must be in PEM format, and if curl is built against OpenSSL, the +directory must have been processed using the c_rehash utility supplied with +OpenSSL. Using \fI\-\-capath\fP can allow OpenSSL\-powered curl to make SSL\-connections +much more efficiently than using \fI\-\-cacert\fP if the \fI\-\-cacert\fP file contains many +CA certificates. + +If this option is set, the default capath value is ignored. + +If --capath is provided several times, the last set value is used. + +Example: +.nf +curl --capath /local/directory https://example.com +.fi + +See also \fI\-\-cacert\fP, \fI\-\-dump\-ca\-embed\fP and \fI-k, \-\-insecure\fP. +.IP "\-E, \-\-cert " +(TLS) Use the specified client certificate file when getting a file with HTTPS, FTPS +or another SSL\-based protocol. The certificate must be PEM format. If the +optional password is not specified, it is queried for on the terminal. Note +that this option assumes a certificate file that is the private key and the +client certificate concatenated. See \fI\-E, \-\-cert\fP and \fI\-\-key\fP to specify them +independently. + +In the portion of the argument, you must escape the character +\&":" as "\\:" so that it is not recognized as the password delimiter. Similarly, +you must escape the double quote character as \\" so that it is not recognized +as an escape character. + +If curl is built against OpenSSL, and the engine pkcs11 or pkcs11 +provider is available, then a PKCS#11 URI (RFC 7512) can be used to specify a +certificate located in a PKCS#11 device. A string beginning with "pkcs11:" is +interpreted as a PKCS#11 URI. If a PKCS#11 URI is provided, then the \fI\-\-engine\fP +option is set as "pkcs11" if none was provided and the \fI\-\-cert\-type\fP option is +set as "ENG" or "PROV" if none was provided (depending on OpenSSL version). + +If curl is built against GnuTLS, a PKCS#11 URI can be used to specify +a certificate located in a PKCS#11 device. A string beginning with "pkcs11:" +is interpreted as a PKCS#11 URI. + +(Schannel) Client certificates must be specified by a path expression to a +certificate store. (Loading \fIPFX\fP is not supported; you can import it to a +store first). You can use "\\\\" +to refer to a certificate in the system certificates store, for example, +\fI"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a"\fP. Thumbprint is +usually a SHA\-1 hex string which you can see in certificate details. Following +store locations are supported: \fICurrentUser\fP, \fILocalMachine\fP, +\fICurrentService\fP, \fIServices\fP, \fICurrentUserGroupPolicy\fP, +\fILocalMachineGroupPolicy\fP and \fILocalMachineEnterprise\fP. + +If --cert is provided several times, the last set value is used. + +Example: +.nf +curl --cert certfile --key keyfile https://example.com +.fi + +See also \fI\-\-cert\-type\fP, \fI\-\-key\fP and \fI\-\-key\-type\fP. +.IP "\-\-cert\-status" +(TLS) Verify the status of the server certificate by using the Certificate Status +Request (aka. OCSP stapling) TLS extension. + +If this option is enabled and the server sends an invalid (e.g. expired) +response, if the response suggests that the server certificate has been +revoked, or no response at all is received, the verification fails. + +This support is currently only implemented in the OpenSSL and GnuTLS backends. + +Providing --cert-status multiple times has no extra effect. +Disable it again with \-\-no-cert-status. + +Example: +.nf +curl --cert-status https://example.com +.fi + +See also \fI\-\-pinnedpubkey\fP. +.IP "\-\-cert\-type " +(TLS) Set type of the provided client certificate. PEM, DER, ENG, PROV and P12 are +recognized types. + +The default type depends on the TLS backend and is usually PEM. For Schannel +it is P12. If \fI\-E, \-\-cert\fP is a pkcs11: URI then ENG or PROV is the default type +(depending on OpenSSL version). + +If --cert-type is provided several times, the last set value is used. + +Example: +.nf +curl --cert-type PEM --cert file https://example.com +.fi + +See also \fI-E, \-\-cert\fP, \fI\-\-key\fP and \fI\-\-key\-type\fP. +.IP "\-\-ciphers " +(TLS) Specify which cipher suites to use in the connection if it negotiates TLS 1.2 +(1.1, 1.0). The list of ciphers suites must specify valid ciphers. Read up on +cipher suite details on this URL: + +https://curl.se/docs/ssl\-ciphers.html + +If --ciphers is provided several times, the last set value is used. + +Example: +.nf +curl --ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 https://example.com +.fi + +See also \fI\-\-tls13\-ciphers\fP, \fI\-\-proxy\-ciphers\fP and \fI\-\-curves\fP. +.IP "\-\-compressed" +(HTTP) Request a compressed response using one of the algorithms curl supports, and +automatically decompress the content. + +Response headers are not modified when saved, so if they are "interpreted" +separately again at a later point they might appear to be saying that the +content is (still) compressed; while in fact it has already been decompressed. + +If this option is used and the server sends an unsupported encoding, curl +reports an error. This is a request, not an order; the server may or may not +deliver data compressed. + +Providing --compressed multiple times has no extra effect. +Disable it again with \-\-no-compressed. + +Example: +.nf +curl --compressed https://example.com +.fi + +See also \fI\-\-compressed\-ssh\fP. +.IP "\-\-compressed\-ssh" +(SCP SFTP) Enable SSH compression. This is a request, not an order; the server may or may +not do it. + +Providing --compressed-ssh multiple times has no extra effect. +Disable it again with \-\-no-compressed-ssh. + +Example: +.nf +curl --compressed-ssh sftp://example.com/ +.fi + +See also \fI\-\-compressed\fP. +.IP "\-K, \-\-config " +Specify a text file to read curl arguments from. The command line arguments +found in the text file are used as if they were provided on the command +line. + +Options and their parameters must be specified on the same line in the file, +separated by whitespace, colon, or the equals sign. Long option names can +optionally be given in the config file without the initial double dashes and +if so, the colon or equals characters can be used as separators. If the option +is specified with one or two dashes, there can be no colon or equals character +between the option and its parameter. + +If the parameter contains whitespace or starts with a colon (:) or equals sign +(=), it must be specified enclosed within double quotes ("like this"). Within +double quotes the following escape sequences are available: \\\\, \\", \\t, \\n, \\r +and \\v. A backslash preceding any other letter is ignored. + +If the first non\-blank column of a config line is a \(aq#\(aq character, that line +is treated as a comment. + +Only write one option per physical line in the config file. A single line is +required to be no more than 10 megabytes (since 8.2.0). + +Specify the filename to \fI\-K, \-\-config\fP as minus "\-" to make curl read the file from +stdin. + +Note that to be able to specify a URL in the config file, you need to specify +it using the \fI\-\-url\fP option, and not by simply writing the URL on its own +line. So, it could look similar to this: + +.nf +url = "https://curl.se/docs/" + +# \--\- Example file \--\- +# this is a comment +url = "example.com" +output = "curlhere.html" +user\-agent = "superagent/1.0" + +# and fetch another URL too +url = "example.com/docs/manpage.html" +-O +referer = "http://nowhereatall.example.com/" +# \--\- End of example file \--\- +.fi + +When curl is invoked, it (unless \fI\-q, \-\-disable\fP is used) checks for a default +config file and uses it if found, even when \fI\-K, \-\-config\fP is used. The default +config file is checked for in the following places in this order: + +1) \fB"$CURL_HOME/.curlrc"\fP + +2) \fB"$XDG_CONFIG_HOME/curlrc"\fP (Added in 7.73.0) + +3) \fB"$HOME/.curlrc"\fP + +4) Windows: \fB"%USERPROFILE%\\.curlrc"\fP + +5) Windows: \fB"%APPDATA%\\.curlrc"\fP + +6) Windows: \fB"%USERPROFILE%\\Application Data\\.curlrc"\fP + +7) Non\-Windows: use getpwuid to find the home directory + +8) On Windows, if it finds no \fI.curlrc\fP file in the sequence described above, it +checks for one in the same directory the curl executable is placed. + +On Windows two filenames are checked per location: \fI.curlrc\fP and \fI_curlrc\fP, +preferring the former. Older versions on Windows checked for \fI_curlrc\fP only. + +--config can be used several times in a command line + +Example: +.nf +curl --config file.txt https://example.com +.fi + +See also \fI-q, \-\-disable\fP. +.IP "\-\-connect\-timeout " +Maximum time in seconds that you allow curl\(aqs connection to take. This only +limits the connection phase, so if curl connects within the given period it +continues \- if not it exits. + +This option accepts decimal values. The decimal value needs +to be provided using a dot (.) as decimal separator \- not the local version +even if it might be using another separator. + +The connection phase is considered complete when the DNS lookup and requested +TCP, TLS or QUIC handshakes are done. + +If --connect-timeout is provided several times, the last set value is used. + +Examples: +.nf +curl --connect-timeout 20 https://example.com +curl --connect-timeout 3.14 https://example.com +.fi + +See also \fI-m, \-\-max\-time\fP. +.IP "\-\-connect\-to " +For a request intended for the "HOST1:PORT1" pair, connect to "HOST2:PORT2" +instead. This option is only used to establish the network connection. It does +NOT affect the hostname/port number that is used for TLS/SSL (e.g. SNI, +certificate verification) or for the application protocols. + +\&"HOST1" and "PORT1" may be empty strings, meaning any host or any port number. +\&"HOST2" and "PORT2" may also be empty strings, meaning use the request\(aqs +original hostname and port number. + +A hostname specified to this option is compared as a string, so it needs to +match the name used in the request URL. It can be either numerical such as +\&"127.0.0.1" or the full host name such as "example.org". + +Example: redirect connects from the example.com hostname to 127.0.0.1 +independently of port number: + +.nf +curl \--connect\-to example.com::127.0.0.1: https://example.com/ +.fi + +Example: redirect connects from all hostnames to 127.0.0.1 independently of +port number: + +.nf +curl \--connect\-to ::127.0.0.1: http://example.com/ +.fi + +--connect-to can be used several times in a command line + +Example: +.nf +curl --connect-to example.com:443:example.net:8443 https://example.com +.fi + +See also \fI\-\-resolve\fP and \fI-H, \-\-header\fP. +.IP "\-C, \-\-continue\-at " +Resume a previous transfer from the given byte offset. The given offset is the +exact number of bytes that are skipped, counting from the beginning of the +source file before it is transferred to the destination. If used with uploads, +the FTP server command SIZE is not used by curl. + +Use "\-C \-" to instruct curl to automatically find out where/how to resume the +transfer. It then uses the given output/input files to figure that out. + +When using this option for HTTP uploads using POST or PUT, functionality is +not guaranteed. The HTTP protocol has no standard interoperable resume upload +and curl uses a set of headers for this purpose that once proved working for +some servers and have been left for those who find that useful. + +This command line option is mutually exclusive with \fI\-r, \-\-range\fP: you can only use +one of them for a single transfer. + +The \fI\-\-no\-clobber\fP and \fI\-\-remove\-on\-error\fP options cannot be used together with +\fI\-C, \-\-continue\-at\fP. + +If --continue-at is provided several times, the last set value is used. + +Examples: +.nf +curl -C - https://example.com +curl -C 400 https://example.com +.fi + +See also \fI-r, \-\-range\fP. +.IP "\-b, \-\-cookie " +(HTTP) This option has two slightly separate cookie sending functions. + +Either: pass the exact data to send to the HTTP server in the Cookie header. +It is supposedly data previously received from the server in a "Set\-Cookie:" +line. The data should be in the format "NAME1=VALUE1; NAME2=VALUE2". When +given a set of specific cookies, curl populates its cookie header with this +content explicitly in all outgoing request(s). If multiple requests are done +due to authentication, followed redirects or similar, they all get this cookie +header passed on. + +Or: If no "=" symbol is used in the argument, it is instead treated as a +filename to read previously stored cookie from. This option also activates the +cookie engine which makes curl record incoming cookies, which may be handy if +you are using this in combination with the \fI\-L, \-\-location\fP option or do multiple +URL transfers on the same invoke. + +If the filename is a single minus ("\-"), curl reads the contents from stdin. +If the filename is an empty string ("") and is the only cookie input, curl +activates the cookie engine without any cookies. + +The file format of the file to read cookies from should be plain HTTP headers +(Set\-Cookie style) or the Netscape/Mozilla cookie file format. + +The file specified with \fI\-b, \-\-cookie\fP is only used as input. No cookies are written +to that file. To store cookies, use the \fI\-c, \-\-cookie\-jar\fP option. + +If you use the Set\-Cookie file format and do not specify a domain then the +cookie is not sent since the domain never matches. To address this, set a +domain in Set\-Cookie line (doing that includes subdomains) or preferably: use +the Netscape format. + +Users often want to both read cookies from a file and write updated cookies +back to a file, so using both \fI\-b, \-\-cookie\fP and \fI\-c, \-\-cookie\-jar\fP in the same command +line is common. + +If curl is built with PSL (\fBPublic Suffix List\fP) support, it detects and +discards cookies that are specified for such suffix domains that should not be +allowed to have cookies. If curl is \fInot\fP built with PSL support, it has no +ability to stop super cookies. + +--cookie can be used several times in a command line + +Examples: +.nf +curl -b "" https://example.com +curl -b cookiefile https://example.com +curl -b cookiefile -c cookiefile https://example.com +curl -b name=Jane https://example.com +.fi + +See also \fI-c, \-\-cookie\-jar\fP and \fI-j, \-\-junk\-session\-cookies\fP. +.IP "\-c, \-\-cookie\-jar " +(HTTP) Specify to which file you want curl to write all cookies after a completed +operation. curl writes all cookies from its in\-memory cookie storage to the +given file at the end of operations. Even if no cookies are known, a file is +created so that it removes any formerly existing cookies from the file. The +file uses the Netscape cookie file format. If you set the filename to a single +minus, "\-", the cookies are written to stdout. + +The file specified with \fI\-c, \-\-cookie\-jar\fP is only used for output. No cookies are +read from the file. To read cookies, use the \fI\-b, \-\-cookie\fP option. Both options +can specify the same file. + +This command line option activates the cookie engine that makes curl record +and use cookies. The \fI\-b, \-\-cookie\fP option also activates it. + +If the cookie jar cannot be created or written to, the whole curl operation +does not fail or even report an error clearly. Using \fI\-v, \-\-verbose\fP gets a warning +displayed, but that is the only visible feedback you get about this possibly +lethal situation. + +If --cookie-jar is provided several times, the last set value is used. + +Examples: +.nf +curl -c store-here.txt https://example.com +curl -c store-here.txt -b read-these https://example.com +.fi + +See also \fI-b, \-\-cookie\fP and \fI-j, \-\-junk\-session\-cookies\fP. +.IP "\-\-create\-dirs" +When used in conjunction with the \fI\-o, \-\-output\fP option, curl creates the necessary +local directory hierarchy as needed. This option creates the directories +mentioned with the \fI\-o, \-\-output\fP option combined with the path possibly set with +\fI\-\-output\-dir\fP. If the combined output filename uses no directory, or if the +directories it mentions already exist, no directories are created. + +Created directories are made with mode 0750 on Unix\-style file systems. + +To create remote directories when using FTP or SFTP, try \fI\-\-ftp\-create\-dirs\fP. + +Providing --create-dirs multiple times has no extra effect. +Disable it again with \-\-no-create-dirs. + +Example: +.nf +curl --create-dirs --output local/dir/file https://example.com +.fi + +See also \fI\-\-ftp\-create\-dirs\fP and \fI\-\-output\-dir\fP. +.IP "\-\-create\-file\-mode " +(SFTP SCP FILE) When curl is used to create files remotely using one of the supported +protocols, this option allows the user to set which \(aqmode\(aq to set on the file +at creation time, instead of the default 0644. + +This option takes an octal number as argument. + +If --create-file-mode is provided several times, the last set value is used. + +Example: +.nf +curl --create-file-mode 0777 -T localfile sftp://example.com/new +.fi + +Added in 7.75.0. See also \fI\-\-ftp\-create\-dirs\fP. +.IP "\-\-crlf" +(FTP SMTP) Convert line feeds to carriage return plus line feeds in upload. Useful for +\fBMVS (OS/390)\fP. + +Providing --crlf multiple times has no extra effect. +Disable it again with \-\-no-crlf. + +Example: +.nf +curl --crlf -T file ftp://example.com/ +.fi + +See also \fI-B, \-\-use\-ascii\fP. +.IP "\-\-crlfile " +(TLS) Provide a file using PEM format with a Certificate Revocation List that may +specify peer certificates that are to be considered revoked. + +If --crlfile is provided several times, the last set value is used. + +Example: +.nf +curl --crlfile rejects.txt https://example.com +.fi + +See also \fI\-\-cacert\fP and \fI\-\-capath\fP. +.IP "\-\-curves " +(TLS) Set specific curves to use during SSL session establishment according to RFC +8422, 5.1. Multiple algorithms can be provided by separating them with ":" +(e.g. "X25519:P\-521"). The parameter is available identically in the OpenSSL +\&"s_client" and "s_server" utilities. + +\fI\-\-curves\fP allows a OpenSSL powered curl to make SSL\-connections with exactly +the (EC) curve requested by the client, avoiding nontransparent client/server +negotiations. + +If this option is set, the default curves list built into OpenSSL are ignored. + +If --curves is provided several times, the last set value is used. + +Example: +.nf +curl --curves X25519 https://example.com +.fi + +Added in 7.73.0. See also \fI\-\-ciphers\fP. +.IP "\-d, \-\-data " +(HTTP MQTT) Send the specified data in a POST request to the HTTP server, in the same way +that a browser does when a user has filled in an HTML form and presses the +submit button. This option makes curl pass the data to the server using the +content\-type application/x\-www\-form\-urlencoded. Compared to \fI\-F, \-\-form\fP. + +\fI\-\-data\-raw\fP is almost the same but does not have a special interpretation of +the @ character. To post data purely binary, you should instead use the +\fI\-\-data\-binary\fP option. To URL\-encode the value of a form field you may use +\fI\-\-data\-urlencode\fP. + +If any of these options is used more than once on the same command line, the +data pieces specified are merged with a separating &\-symbol. Thus, using +\(aq\-d name=daniel \-d skill=lousy\(aq would generate a post chunk that looks like +\(aqname=daniel&skill=lousy\(aq. + +If you start the data with the letter @, the rest should be a filename to read +the data from, or \- if you want curl to read the data from stdin. Posting data +from a file named \(aqfoobar\(aq would thus be done with \fI\-d, \-\-data\fP @foobar. When \fI\-d, \-\-data\fP +is told to read from a file like that, carriage returns, newlines and null +bytes are stripped out. If you do not want the @ character to have a special +interpretation use \fI\-\-data\-raw\fP instead. + +The data for this option is passed on to the server exactly as provided on the +command line. curl does not convert, change or improve it. It is up to the +user to provide the data in the correct form. + +--data can be used several times in a command line + +Examples: +.nf +curl -d "name=curl" https://example.com +curl -d "name=curl" -d "tool=cmdline" https://example.com +curl -d @filename https://example.com +.fi + +This option is mutually exclusive with \fI-F, \-\-form\fP, \fI-I, \-\-head\fP and \fI-T, \-\-upload\-file\fP. +See also \fI\-\-data\-binary\fP, \fI\-\-data\-urlencode\fP and \fI\-\-data\-raw\fP. +.IP "\-\-data\-ascii " +(HTTP) This option is just an alias for \fI\-d, \-\-data\fP. + +--data-ascii can be used several times in a command line + +Example: +.nf +curl --data-ascii @file https://example.com +.fi + +See also \fI\-\-data\-binary\fP, \fI\-\-data\-raw\fP and \fI\-\-data\-urlencode\fP. +.IP "\-\-data\-binary " +(HTTP) Post data exactly as specified with no extra processing whatsoever. + +If you start the data with the letter @, the rest should be a filename. +\&"@\-" makes curl read the data from stdin. Data is posted in a similar +manner as \fI\-d, \-\-data\fP does, except that newlines and carriage returns are +preserved and conversions are never done. + +Like \fI\-d, \-\-data\fP the default content\-type sent to the server is +application/x\-www\-form\-urlencoded. If you want the data to be treated as +arbitrary binary data by the server then set the content\-type to octet\-stream: +-H "Content\-Type: application/octet\-stream". + +If this option is used several times, the ones following the first append +data as described in \fI\-d, \-\-data\fP. + +--data-binary can be used several times in a command line + +Example: +.nf +curl --data-binary @filename https://example.com +.fi + +See also \fI\-\-data\-ascii\fP. +.IP "\-\-data\-raw " +(HTTP) Post data similarly to \fI\-d, \-\-data\fP but without the special interpretation of the @ +character. + +--data-raw can be used several times in a command line + +Examples: +.nf +curl --data-raw "hello" https://example.com +curl --data-raw "@at@at@" https://example.com +.fi + +See also \fI-d, \-\-data\fP. +.IP "\-\-data\-urlencode " +(HTTP) Post data, similar to the other \fI\-d, \-\-data\fP options with the exception that this +performs URL\-encoding. + +To be CGI\-compliant, the part should begin with a \fIname\fP followed by +a separator and a content specification. The part can be passed to +curl using one of the following syntaxes: +.RS +.IP content +URL\-encode the content and pass that on. Just be careful so that the content +does not contain any "=" or "@" symbols, as that makes the syntax match one of +the other cases below. +.IP =content +URL\-encode the content and pass that on. The preceding "=" symbol is not +included in the data. +.IP name=content +URL\-encode the content part and pass that on. Note that the name part is +expected to be URL\-encoded already. +.IP @filename +load data from the given file (including any newlines), URL\-encode that data +and pass it on in the POST. Using "@\-" makes curl read the data from stdin. +.IP name@filename +load data from the given file (including any newlines), URL\-encode that data +and pass it on in the POST. The name part gets an equal sign appended, +resulting in \fIname=urlencoded\-file\-content\fP. Note that the name is expected to +be URL\-encoded already. +.RE +.IP + +--data-urlencode can be used several times in a command line + +Examples: +.nf +curl --data-urlencode name=val https://example.com +curl --data-urlencode =encodethis https://example.com +curl --data-urlencode name@file https://example.com +curl --data-urlencode @fileonly https://example.com +.fi + +See also \fI-d, \-\-data\fP and \fI\-\-data\-raw\fP. +.IP "\-\-delegation " +(GSS/kerberos) Set LEVEL what curl is allowed to delegate when it comes to user credentials. +.RS +.IP none +Do not allow any delegation. +.IP policy +Delegates if and only if the OK\-AS\-DELEGATE flag is set in the Kerberos +service ticket, which is a matter of realm policy. +.IP always +Unconditionally allow the server to delegate. +.RE +.IP + +If --delegation is provided several times, the last set value is used. + +Example: +.nf +curl --delegation "none" https://example.com +.fi + +See also \fI-k, \-\-insecure\fP and \fI\-\-ssl\fP. +.IP "\-\-digest" +(HTTP) Enable HTTP Digest authentication. This authentication scheme avoids sending +the password over the wire in clear text. Use this in combination with the +normal \fI\-u, \-\-user\fP option to set username and password. + +Providing --digest multiple times has no extra effect. +Disable it again with \-\-no-digest. + +Example: +.nf +curl -u name:password --digest https://example.com +.fi + +This option is mutually exclusive with \fI\-\-basic\fP, \fI\-\-ntlm\fP and \fI\-\-negotiate\fP. +See also \fI-u, \-\-user\fP, \fI\-\-proxy\-digest\fP and \fI\-\-anyauth\fP. +.IP "\-q, \-\-disable" +If used as the \fBfirst\fP parameter on the command line, the \fIcurlrc\fP config +file is not read or used. See the \fI\-K, \-\-config\fP for details on the default config +file search path. + +Providing --disable multiple times has no extra effect. +Disable it again with \-\-no-disable. + +Example: +.nf +curl -q https://example.com +.fi + +See also \fI-K, \-\-config\fP. +.IP "\-\-disable\-eprt" +(FTP) Disable the use of the EPRT and LPRT commands when doing active FTP transfers. +curl normally first attempts to use EPRT before using PORT, but with this +option, it uses PORT right away. EPRT is an extension to the original FTP +protocol, and does not work on all servers, but enables more functionality in +a better way than the traditional PORT command. + +\fI\-\-eprt\fP can be used to explicitly enable EPRT again and \fI\-\-no\-eprt\fP is an alias +for \fI\-\-disable\-eprt\fP. + +If the server is accessed using IPv6, this option has no effect as EPRT is +necessary then. + +Disabling EPRT only changes the active behavior. If you want to switch to +passive mode you need to not use \fI\-P, \-\-ftp\-port\fP or force it with \fI\-\-ftp\-pasv\fP. + +Providing --disable-eprt multiple times has no extra effect. +Disable it again with \-\-no-disable-eprt. + +Example: +.nf +curl --disable-eprt ftp://example.com/ +.fi + +See also \fI\-\-disable\-epsv\fP and \fI-P, \-\-ftp\-port\fP. +.IP "\-\-disable\-epsv" +(FTP) Disable the use of the EPSV command when doing passive FTP transfers. curl +normally first attempts to use EPSV before PASV, but with this option, it does +not try EPSV. + +\fI\-\-epsv\fP can be used to explicitly enable EPSV again and \fI\-\-no\-epsv\fP is an alias +for \fI\-\-disable\-epsv\fP. + +If the server is an IPv6 host, this option has no effect as EPSV is necessary +then. + +Disabling EPSV only changes the passive behavior. If you want to switch to +active mode you need to use \fI\-P, \-\-ftp\-port\fP. + +Providing --disable-epsv multiple times has no extra effect. +Disable it again with \-\-no-disable-epsv. + +Example: +.nf +curl --disable-epsv ftp://example.com/ +.fi + +See also \fI\-\-disable\-eprt\fP and \fI-P, \-\-ftp\-port\fP. +.IP "\-\-disallow\-username\-in\-url" +Exit with error if passed a URL containing a username. Probably most useful +when the URL is being provided at runtime or similar. + +Providing --disallow-username-in-url multiple times has no extra effect. +Disable it again with \-\-no-disallow-username-in-url. + +Example: +.nf +curl --disallow-username-in-url https://example.com +.fi + +Added in 7.61.0. See also \fI\-\-proto\fP. +.IP "\-\-dns\-interface " +(DNS) Send outgoing DNS requests through the given interface. This option is a +counterpart to \fI\-\-interface\fP (which does not affect DNS). The supplied string +must be an interface name (not an address). + +If --dns-interface is provided several times, the last set value is used. + +Example: +.nf +curl --dns-interface eth0 https://example.com +.fi + +\fI\-\-dns\-interface\fP requires that libcurl is built to support c-ares. +See also \fI\-\-dns\-ipv4\-addr\fP and \fI\-\-dns\-ipv6\-addr\fP. +.IP "\-\-dns\-ipv4\-addr
" +(DNS) Bind to a specific IP address when making IPv4 DNS requests, so that the DNS +requests originate from this address. The argument should be a single IPv4 +address. + +If --dns-ipv4-addr is provided several times, the last set value is used. + +Example: +.nf +curl --dns-ipv4-addr 10.1.2.3 https://example.com +.fi + +\fI\-\-dns\-ipv4\-addr\fP requires that libcurl is built to support c-ares. +See also \fI\-\-dns\-interface\fP and \fI\-\-dns\-ipv6\-addr\fP. +.IP "\-\-dns\-ipv6\-addr
" +(DNS) Bind to a specific IP address when making IPv6 DNS requests, so that the DNS +requests originate from this address. The argument should be a single IPv6 +address. + +If --dns-ipv6-addr is provided several times, the last set value is used. + +Example: +.nf +curl --dns-ipv6-addr 2a04:4e42::561 https://example.com +.fi + +\fI\-\-dns\-ipv6\-addr\fP requires that libcurl is built to support c-ares. +See also \fI\-\-dns\-interface\fP and \fI\-\-dns\-ipv4\-addr\fP. +.IP "\-\-dns\-servers " +(DNS) Set the list of DNS servers to be used instead of the system default. The list +of IP addresses should be separated with commas. Port numbers may also +optionally be given, appended to the IP address separated with a colon. + +If --dns-servers is provided several times, the last set value is used. + +Examples: +.nf +curl --dns-servers 192.168.0.1,192.168.0.2 https://example.com +curl --dns-servers 10.0.0.1:53 https://example.com +.fi + +\fI\-\-dns\-servers\fP requires that libcurl is built to support c-ares. +See also \fI\-\-dns\-interface\fP and \fI\-\-dns\-ipv4\-addr\fP. +.IP "\-\-doh\-cert\-status" +Same as \fI\-\-cert\-status\fP but used for DoH (DNS\-over\-HTTPS). + +Verify the status of the DoH servers\(aq certificate by using the Certificate +Status Request (aka. OCSP stapling) TLS extension. + +If this option is enabled and the DoH server sends an invalid (e.g. expired) +response, if the response suggests that the server certificate has been +revoked, or no response at all is received, the verification fails. + +This support is currently only implemented in the OpenSSL and GnuTLS backends. + +Providing --doh-cert-status multiple times has no extra effect. +Disable it again with \-\-no-doh-cert-status. + +Example: +.nf +curl --doh-cert-status --doh-url https://doh.example https://example.com +.fi + +Added in 7.76.0. See also \fI\-\-doh\-insecure\fP. +.IP "\-\-doh\-insecure" +By default, every connection curl makes to a DoH server is verified to be +secure before the transfer takes place. This option tells curl to skip the +verification step and proceed without checking. + +\fBWARNING\fP: using this option makes the DoH transfer and name resolution +insecure. + +This option is equivalent to \fI\-k, \-\-insecure\fP and \fI\-\-proxy\-insecure\fP but used for DoH +(DNS\-over\-HTTPS) only. + +Providing --doh-insecure multiple times has no extra effect. +Disable it again with \-\-no-doh-insecure. + +Example: +.nf +curl --doh-insecure --doh-url https://doh.example https://example.com +.fi + +Added in 7.76.0. See also \fI\-\-doh\-url\fP, \fI-k, \-\-insecure\fP and \fI\-\-proxy\-insecure\fP. +.IP "\-\-doh\-url " +Specify which DNS\-over\-HTTPS (DoH) server to use to resolve hostnames, instead +of using the default name resolver mechanism. The URL must be HTTPS. + +Some SSL options that you set for your transfer also apply to DoH since the +name lookups take place over SSL. However, the certificate verification +settings are not inherited but are controlled separately via \fI\-\-doh\-insecure\fP +and \fI\-\-doh\-cert\-status\fP. + +By default, DoH is bypassed when initially looking up DNS records of the DoH server. You can specify the IP address(es) of the DoH server with \fI\-\-resolve\fP to avoid this. + +This option is unset if an empty string "" is used as the URL. +(Added in 7.85.0) + +If --doh-url is provided several times, the last set value is used. + +Examples: +.nf +curl --doh-url https://doh.example https://example.com +curl --doh-url https://doh.example --resolve doh.example:443:192.0.2.1 https://example.com +.fi + +Added in 7.62.0. See also \fI\-\-doh\-insecure\fP. +.IP "\-\-dump\-ca\-embed" +(TLS) Write the CA bundle embedded in curl to standard output, then quit. + +If curl was not built with a default CA bundle embedded, the output is empty. + +Providing --dump-ca-embed multiple times has no extra effect. +Disable it again with \-\-no-dump-ca-embed. + +Example: +.nf +curl --dump-ca-embed +.fi + +Added in 8.10.0. See also \fI\-\-ca\-native\fP, \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-proxy\-ca\-native\fP, \fI\-\-proxy\-cacert\fP and \fI\-\-proxy\-capath\fP. +.IP "\-D, \-\-dump\-header " +(HTTP FTP) Write the received protocol headers to the specified file. If no headers are +received, the use of this option creates an empty file. Specify "\-" as +filename (a single minus) to have it written to stdout. + +Starting in curl 8.10.0, specify "%" (a single percent sign) as filename +writes the output to stderr. + +When used in FTP, the FTP server response lines are considered being "headers" +and thus are saved there. + +Starting in curl 8.11.0, using the \fI\-\-create\-dirs\fP option can also create +missing directory components for the path provided in \fI\-D, \-\-dump\-header\fP. + +Having multiple transfers in one set of operations (i.e. the URLs in one +\fI\-:, \-\-next\fP clause), appends them to the same file, separated by a blank line. + +If --dump-header is provided several times, the last set value is used. + +Examples: +.nf +curl --dump-header store.txt https://example.com +curl --dump-header - https://example.com -o save +.fi + +See also \fI-o, \-\-output\fP. +.IP "\-\-ech " +(HTTPS) Specify how to do ECH (Encrypted Client Hello). + +The values allowed for can be: +.RS +.IP false +Do not attempt ECH. The is the default. +.IP grease +Send a GREASE ECH extension +.IP true +Attempt ECH if possible, but do not fail if ECH is not attempted. +(The connection fails if ECH is attempted but fails.) +.IP hard +Attempt ECH and fail if that is not possible. ECH only works with TLS 1.3 and +also requires using DoH or providing an ECHConfigList on the command line. +.IP ecl: +A base64 encoded ECHConfigList that is used for ECH. +.IP pn: +A name to use to over\-ride the "public_name" field of an ECHConfigList (only +available with OpenSSL TLS support) +.RE +.IP +Most ECH related errors cause error \fICURLE_ECH_REQUIRED\fP (101). + +If --ech is provided several times, the last set value is used. + +Example: +.nf +curl --ech true https://example.com +.fi + +Added in 8.8.0. See also \fI\-\-doh\-url\fP. +.IP "\-\-egd\-file " +(TLS) Deprecated option (added in 7.84.0). Prior to that it only had an effect on +curl if built to use old versions of OpenSSL. + +Specify the path name to the Entropy Gathering Daemon socket. The socket is +used to seed the random engine for SSL connections. + +If --egd-file is provided several times, the last set value is used. + +Example: +.nf +curl --egd-file /random/here https://example.com +.fi + +See also \fI\-\-random\-file\fP. +.IP "\-\-engine " +(TLS) Select the OpenSSL crypto engine to use for cipher operations. Use \fI\-\-engine\fP +list to print a list of build\-time supported engines. Note that not all (and +possibly none) of the engines may be available at runtime. + +If --engine is provided several times, the last set value is used. + +Example: +.nf +curl --engine flavor https://example.com +.fi + +See also \fI\-\-ciphers\fP and \fI\-\-curves\fP. +.IP "\-\-etag\-compare " +(HTTP) Make a conditional HTTP request for the specific ETag read from the given file +by sending a custom If\-None\-Match header using the stored ETag. + +For correct results, make sure that the specified file contains only a single +line with the desired ETag. A non\-existing or empty file is treated as an +empty ETag. + +Use the option \fI\-\-etag\-save\fP to first save the ETag from a response, and then +use this option to compare against the saved ETag in a subsequent request. + +Use this option with a single URL only. + +If --etag-compare is provided several times, the last set value is used. + +Example: +.nf +curl --etag-compare etag.txt https://example.com +.fi + +Added in 7.68.0. See also \fI\-\-etag\-save\fP and \fI-z, \-\-time\-cond\fP. +.IP "\-\-etag\-save " +(HTTP) Save an HTTP ETag to the specified file. An ETag is a caching related header, +usually returned in a response. Use this option with a single URL only. + +If no ETag is sent by the server, an empty file is created. + +In many situations you want to use an existing etag in the request to avoid +downloading the same resource again but also save the new etag if it has +indeed changed, by using both etag options \fI\-\-etag\-save\fP and \fI\-\-etag\-compare\fP with +the same filename, in the same command line. + +Starting in curl 8.12.0, using the \fI\-\-create\-dirs\fP option can also create +missing directory components for the path provided in \fI\-\-etag\-save\fP. + +If --etag-save is provided several times, the last set value is used. + +Example: +.nf +curl --etag-save storetag.txt https://example.com +.fi + +Added in 7.68.0. See also \fI\-\-etag\-compare\fP. +.IP "\-\-expect100\-timeout " +(HTTP) Maximum time in seconds that you allow curl to wait for a 100\-continue +response when curl emits an Expects: 100\-continue header in its request. By +default curl waits one second. This option accepts decimal values. When curl +stops waiting, it continues as if a response was received. + +The decimal value needs to be provided using a dot (".") as decimal separator \- +not the local version even if it might be using another separator. + +If --expect100-timeout is provided several times, the last set value is used. + +Example: +.nf +curl --expect100-timeout 2.5 -T file https://example.com +.fi + +See also \fI\-\-connect\-timeout\fP. +.IP "\-f, \-\-fail" +(HTTP) Fail with error code 22 and with no response body output at all for HTTP +transfers returning HTTP response codes at 400 or greater. + +In normal cases when an HTTP server fails to deliver a document, it returns a +body of text stating so (which often also describes why and more) and a 4xx +HTTP response code. This command line option prevents curl from outputting +that data and instead returns error 22 early. By default, curl does not +consider HTTP response codes to indicate failure. + +To get both the error code and also save the content, use \fI\-\-fail\-with\-body\fP +instead. + +This method is not fail\-safe and there are occasions where non\-successful +response codes slip through, especially when authentication is involved +(response codes 401 and 407). + +Providing --fail multiple times has no extra effect. +Disable it again with \-\-no-fail. + +Example: +.nf +curl --fail https://example.com +.fi + +This option is mutually exclusive with \fI\-\-fail\-with\-body\fP. +See also \fI\-\-fail\-with\-body\fP and \fI\-\-fail\-early\fP. +.IP "\-\-fail\-early" +Fail and exit on the first detected transfer error. + +When curl is used to do multiple transfers on the command line, it attempts to +operate on each given URL, one by one. By default, it ignores errors if there +are more URLs given and the last URL\(aqs success determines the error code curl +returns. Early failures are "hidden" by subsequent successful transfers. + +Using this option, curl instead returns an error on the first transfer that +fails, independent of the amount of URLs that are given on the command +line. This way, no transfer failures go undetected by scripts and similar. + +This option does not imply \fI\-f, \-\-fail\fP, which causes transfers to fail due to the +server\(aqs HTTP status code. You can combine the two options, however note \fI\-f, \-\-fail\fP +is not global and is therefore contained by \fI\-:, \-\-next\fP. + +This option is global and does not need to be specified for each use of --next. + +Providing --fail-early multiple times has no extra effect. +Disable it again with \-\-no-fail-early. + +Example: +.nf +curl --fail-early https://example.com https://two.example +.fi + +See also \fI-f, \-\-fail\fP and \fI\-\-fail\-with\-body\fP. +.IP "\-\-fail\-with\-body" +(HTTP) Return an error on server errors where the HTTP response code is 400 or +greater). In normal cases when an HTTP server fails to deliver a document, it +returns an HTML document stating so (which often also describes why and more). +This option allows curl to output and save that content but also to return +error 22. + +This is an alternative option to \fI\-f, \-\-fail\fP which makes curl fail for the same +circumstances but without saving the content. + +Providing --fail-with-body multiple times has no extra effect. +Disable it again with \-\-no-fail-with-body. + +Example: +.nf +curl --fail-with-body https://example.com +.fi + +This option is mutually exclusive with \fI-f, \-\-fail\fP. +Added in 7.76.0. See also \fI-f, \-\-fail\fP and \fI\-\-fail\-early\fP. +.IP "\-\-false\-start" +(TLS) No TLS backend currently supports this feature. + +Use false start during the TLS handshake. False start is a mode where a TLS +client starts sending application data before verifying the server\(aqs Finished +message, thus saving a round trip when performing a full handshake. + +Providing --false-start multiple times has no extra effect. +Disable it again with \-\-no-false-start. + +Example: +.nf +curl --false-start https://example.com +.fi + +See also \fI\-\-tcp\-fastopen\fP. +.IP "\-F, \-\-form " +(HTTP SMTP IMAP) For the HTTP protocol family, emulate a filled\-in form in which a user has +pressed the submit button. This makes curl POST data using the Content\-Type +multipart/form\-data according to RFC 2388. + +For SMTP and IMAP protocols, this composes a multipart mail message to +transmit. + +This enables uploading of binary files etc. To force the \(aqcontent\(aq part to be +a file, prefix the filename with an @ sign. To just get the content part from +a file, prefix the filename with the symbol <. The difference between @ and +< is then that @ makes a file get attached in the post as a file upload, +while the < makes a text field and just gets the contents for that text field +from a file. + +Read content from stdin instead of a file by using a single "\-" as filename. +This goes for both @ and < constructs. When stdin is used, the contents is +buffered in memory first by curl to determine its size and allow a possible +resend. Defining a part\(aqs data from a named non\-regular file (such as a named +pipe or similar) is not subject to buffering and is instead read at +transmission time; since the full size is unknown before the transfer starts, +such data is sent as chunks by HTTP and rejected by IMAP. + +Example: send an image to an HTTP server, where \(aqprofile\(aq is the name of the +form\-field to which the file \fBportrait.jpg\fP is the input: + +.nf +curl \-F profile=@portrait.jpg https://example.com/upload.cgi +.fi + +Example: send your name and shoe size in two text fields to the server: + +.nf +curl \-F name=John \-F shoesize=11 https://example.com/ +.fi + +Example: send your essay in a text field to the server. Send it as a plain +text field, but get the contents for it from a local file: + +.nf +curl \-F "story=HTML message;type=text/html\(aq \\ + \-F \(aq=)\(aq \-F \(aq=@textfile.txt\(aq ... smtp://example.com +.fi + +Data can be encoded for transfer using encoder=. Available encodings are +\fIbinary\fP and \fI8bit\fP that do nothing else than adding the corresponding +Content\-Transfer\-Encoding header, \fI7bit\fP that only rejects 8\-bit characters +with a transfer error, \fIquoted\-printable\fP and \fIbase64\fP that encodes data +according to the corresponding schemes, limiting lines length to 76 +characters. + +Example: send multipart mail with a quoted\-printable text message and a +base64 attached file: + +.nf +curl \-F \(aq=text message;encoder=quoted\-printable\(aq \\ + \-F \(aq=@localfile;encoder=base64\(aq ... smtp://example.com +.fi + +See further examples and details in the MANUAL. + +--form can be used several times in a command line + +Example: +.nf +curl --form "name=curl" --form "file=@loadthis" https://example.com +.fi + +This option is mutually exclusive with \fI-d, \-\-data\fP, \fI-I, \-\-head\fP and \fI-T, \-\-upload\-file\fP. +See also \fI-d, \-\-data\fP, \fI\-\-form\-string\fP and \fI\-\-form\-escape\fP. +.IP "\-\-form\-escape" +(HTTP imap smtp) Pass on names of multipart form fields and files using backslash\-escaping +instead of percent\-encoding. + +If --form-escape is provided several times, the last set value is used. + +Example: +.nf +curl --form-escape -F 'field\\name=curl' -F 'file=@load"this' https://example.com +.fi + +Added in 7.81.0. See also \fI-F, \-\-form\fP. +.IP "\-\-form\-string " +(HTTP SMTP IMAP) Similar to \fI\-F, \-\-form\fP except that the value string for the named parameter is used +literally. Leading @ and < characters, and the ";type=" string in the value +have no special meaning. Use this in preference to \fI\-F, \-\-form\fP if there is any +possibility that the string value may accidentally trigger the @ or < +features of \fI\-F, \-\-form\fP. + +--form-string can be used several times in a command line + +Example: +.nf +curl --form-string "name=data" https://example.com +.fi + +See also \fI-F, \-\-form\fP. +.IP "\-\-ftp\-account " +(FTP) When an FTP server asks for "account data" after username and password has +been provided, this data is sent off using the ACCT command. + +If --ftp-account is provided several times, the last set value is used. + +Example: +.nf +curl --ftp-account "mr.robot" ftp://example.com/ +.fi + +See also \fI-u, \-\-user\fP. +.IP "\-\-ftp\-alternative\-to\-user " +(FTP) If authenticating with the USER and PASS commands fails, send this command. +When connecting to Tumbleweed\(aqs Secure Transport server over FTPS using a +client certificate, using "SITE AUTH" tells the server to retrieve the +username from the certificate. + +If --ftp-alternative-to-user is provided several times, the last set value is used. + +Example: +.nf +curl --ftp-alternative-to-user "U53r" ftp://example.com +.fi + +See also \fI\-\-ftp\-account\fP and \fI-u, \-\-user\fP. +.IP "\-\-ftp\-create\-dirs" +(FTP SFTP) When an FTP or SFTP URL/operation uses a path that does not currently exist on +the server, the standard behavior of curl is to fail. Using this option, curl +instead attempts to create missing directories. + +Providing --ftp-create-dirs multiple times has no extra effect. +Disable it again with \-\-no-ftp-create-dirs. + +Example: +.nf +curl --ftp-create-dirs -T file ftp://example.com/remote/path/file +.fi + +See also \fI\-\-create\-dirs\fP. +.IP "\-\-ftp\-method " +(FTP) Control what method curl should use to reach a file on an FTP(S) +server. The method argument should be one of the following alternatives: +.RS +.IP multicwd +Do a single CWD operation for each path part in the given URL. For deep +hierarchies this means many commands. This is how RFC 1738 says it should be +done. This is the default but the slowest behavior. +.IP nocwd +Do no CWD at all. curl does SIZE, RETR, STOR etc and gives the full path to +the server for each of these commands. This is the fastest behavior. +.IP singlecwd +Do one CWD with the full target directory and then operate on the file +\&"normally" (like in the multicwd case). This is somewhat more standards +compliant than "nocwd" but without the full penalty of "multicwd". +.RE +.IP + +If --ftp-method is provided several times, the last set value is used. + +Examples: +.nf +curl --ftp-method multicwd ftp://example.com/dir1/dir2/file +curl --ftp-method nocwd ftp://example.com/dir1/dir2/file +curl --ftp-method singlecwd ftp://example.com/dir1/dir2/file +.fi + +See also \fI-l, \-\-list\-only\fP. +.IP "\-\-ftp\-pasv" +(FTP) Use passive mode for the data connection. Passive is the internal default +behavior, but using this option can be used to override a previous \fI\-P, \-\-ftp\-port\fP +option. + +Reversing an enforced passive really is not doable but you must then instead +enforce the correct \fI\-P, \-\-ftp\-port\fP again. + +Passive mode means that curl tries the EPSV command first and then PASV, +unless \fI\-\-disable\-epsv\fP is used. + +Providing --ftp-pasv multiple times has no extra effect. + +Example: +.nf +curl --ftp-pasv ftp://example.com/ +.fi + +This option is mutually exclusive with \fI-P, \-\-ftp\-port\fP. +See also \fI\-\-disable\-epsv\fP. +.IP "\-P, \-\-ftp\-port
" +(FTP) Reverse the default initiator/listener roles when connecting with FTP. This +option makes curl use active mode. curl then commands the server to connect +back to the client\(aqs specified address and port, while passive mode asks the +server to setup an IP address and port for it to connect to.
+should be one of: +.RS +.IP interface +e.g. \fBeth0\fP to specify which interface\(aqs IP address you want to use (Unix only) +.IP "IP address" +e.g. \fB192.168.10.1\fP to specify the exact IP address +.IP hostname +e.g. \fBmy.host.domain\fP to specify the machine +.IP - +make curl pick the same IP address that is already used for the control +connection. This is the recommended choice. +.RE +.IP +Disable the use of PORT with \fI\-\-ftp\-pasv\fP. Disable the attempt to use the EPRT +command instead of PORT by using \fI\-\-disable\-eprt\fP. EPRT is really PORT++. + +You can also append ":[start]\-[end]" to the right of the address, to tell +curl what TCP port range to use. That means you specify a port range, from a +lower to a higher number. A single number works as well, but do note that it +increases the risk of failure since the port may not be available. + + +If --ftp-port is provided several times, the last set value is used. + +Examples: +.nf +curl -P - ftp:/example.com +curl -P eth0 ftp:/example.com +curl -P 192.168.0.2 ftp:/example.com +.fi + +See also \fI\-\-ftp\-pasv\fP and \fI\-\-disable\-eprt\fP. +.IP "\-\-ftp\-pret" +(FTP) Send a PRET command before PASV (and EPSV). Certain FTP servers, mainly +drftpd, require this non\-standard command for directory listings as well as up +and downloads in PASV mode. + +Providing --ftp-pret multiple times has no extra effect. +Disable it again with \-\-no-ftp-pret. + +Example: +.nf +curl --ftp-pret ftp://example.com/ +.fi + +See also \fI-P, \-\-ftp\-port\fP and \fI\-\-ftp\-pasv\fP. +.IP "\-\-ftp\-skip\-pasv\-ip" +(FTP) Do not use the IP address the server suggests in its response to curl\(aqs PASV +command when curl connects the data connection. Instead curl reuses the same +IP address it already uses for the control connection. + +This option is enabled by default (added in 7.74.0). + +This option has no effect if PORT, EPRT or EPSV is used instead of PASV. + +Providing --ftp-skip-pasv-ip multiple times has no extra effect. +Disable it again with \-\-no-ftp-skip-pasv-ip. + +Example: +.nf +curl --ftp-skip-pasv-ip ftp://example.com/ +.fi + +See also \fI\-\-ftp\-pasv\fP. +.IP "\-\-ftp\-ssl\-ccc" +(FTP) Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after +authenticating. The rest of the control channel communication is +unencrypted. This allows NAT routers to follow the FTP transaction. The +default mode is passive. + +Providing --ftp-ssl-ccc multiple times has no extra effect. +Disable it again with \-\-no-ftp-ssl-ccc. + +Example: +.nf +curl --ftp-ssl-ccc ftps://example.com/ +.fi + +See also \fI\-\-ssl\fP and \fI\-\-ftp\-ssl\-ccc\-mode\fP. +.IP "\-\-ftp\-ssl\-ccc\-mode " +(FTP) Set the CCC mode. The passive mode does not initiate the shutdown, but instead +waits for the server to do it, and does not reply to the shutdown from the +server. The active mode initiates the shutdown and waits for a reply from the +server. + +Providing --ftp-ssl-ccc-mode multiple times has no extra effect. +Disable it again with \-\-no-ftp-ssl-ccc-mode. + +Example: +.nf +curl --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/ +.fi + +See also \fI\-\-ftp\-ssl\-ccc\fP. +.IP "\-\-ftp\-ssl\-control" +(FTP) Require SSL/TLS for the FTP login, clear for transfer. Allows secure +authentication, but non\-encrypted data transfers for efficiency. Fails the +transfer if the server does not support SSL/TLS. + +Providing --ftp-ssl-control multiple times has no extra effect. +Disable it again with \-\-no-ftp-ssl-control. + +Example: +.nf +curl --ftp-ssl-control ftp://example.com +.fi + +See also \fI\-\-ssl\fP. +.IP "\-G, \-\-get" +(HTTP) When used, this option makes all data specified with \fI\-d, \-\-data\fP, \fI\-\-data\-binary\fP or +\fI\-\-data\-urlencode\fP to be used in an HTTP GET request instead of the POST request +that otherwise would be used. curl appends the provided data to the URL as a +query string. + +If used in combination with \fI\-I, \-\-head\fP, the POST data is instead appended to the +URL with a HEAD request. + +Providing --get multiple times has no extra effect. +Disable it again with \-\-no-get. + +Examples: +.nf +curl --get https://example.com +curl --get -d "tool=curl" -d "age=old" https://example.com +curl --get -I -d "tool=curl" https://example.com +.fi + +See also \fI-d, \-\-data\fP and \fI-X, \-\-request\fP. +.IP "\-g, \-\-globoff" +Switch off the URL globbing function. When you set this option, you can +specify URLs that contain the letters {}[] without having curl itself +interpret them. Note that these letters are not normal legal URL contents but +they should be encoded according to the URI standard. + +Providing --globoff multiple times has no extra effect. +Disable it again with \-\-no-globoff. + +Example: +.nf +curl -g "https://example.com/{[]}}}}" +.fi + +See also \fI-K, \-\-config\fP and \fI-q, \-\-disable\fP. +.IP "\-\-happy\-eyeballs\-timeout\-ms " +Set the timeout for Happy Eyeballs. + +Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 +addresses for dual\-stack hosts, giving IPv6 a head\-start of the specified +number of milliseconds. If the IPv6 address cannot be connected to within that +time, then a connection attempt is made to the IPv4 address in parallel. The +first connection to be established is the one that is used. + +The range of suggested useful values is limited. Happy Eyeballs RFC 6555 says +\&"It is RECOMMENDED that connection attempts be paced 150\-250 ms apart to +balance human factors against network load." libcurl currently defaults to +200 ms. Firefox and Chrome currently default to 300 ms. + +If --happy-eyeballs-timeout-ms is provided several times, the last set value is used. + +Example: +.nf +curl --happy-eyeballs-timeout-ms 500 https://example.com +.fi + +See also \fI-m, \-\-max\-time\fP and \fI\-\-connect\-timeout\fP. +.IP "\-\-haproxy\-clientip " +(HTTP) Set a client IP in HAProxy PROXY protocol v1 header at the beginning of the +connection. + +For valid requests, IPv4 addresses must be indicated as a series of exactly +4 integers in the range [0..255] inclusive written in decimal representation +separated by exactly one dot between each other. Heading zeroes are not +permitted in front of numbers in order to avoid any possible confusion +with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal +digits (upper or lower case) delimited by colons between each other, with the +acceptance of one double colon sequence to replace the largest acceptable range +of consecutive zeroes. The total number of decoded bits must be exactly 128. + +Otherwise, any string can be accepted for the client IP and get sent. + +It replaces \fI\-\-haproxy\-protocol\fP if used, it is not necessary to specify both flags. + +If --haproxy-clientip is provided several times, the last set value is used. + +Example: +.nf +curl --haproxy-clientip $IP +.fi + +Added in 8.2.0. See also \fI-x, \-\-proxy\fP. +.IP "\-\-haproxy\-protocol" +(HTTP) Send a HAProxy PROXY protocol v1 header at the beginning of the connection. +This is used by some load balancers and reverse proxies to indicate the +client\(aqs true IP address and port. + +This option is primarily useful when sending test requests to a service that +expects this header. + +Providing --haproxy-protocol multiple times has no extra effect. +Disable it again with \-\-no-haproxy-protocol. + +Example: +.nf +curl --haproxy-protocol https://example.com +.fi + +Added in 7.60.0. See also \fI-x, \-\-proxy\fP. +.IP "\-I, \-\-head" +(HTTP FTP FILE) Fetch the headers only. HTTP\-servers feature the command HEAD which this uses +to get nothing but the header of a document. When used on an FTP or FILE URL, +curl displays the file size and last modification time only. + +Providing --head multiple times has no extra effect. +Disable it again with \-\-no-head. + +Example: +.nf +curl -I https://example.com +.fi + +See also \fI-G, \-\-get\fP, \fI-v, \-\-verbose\fP and \fI\-\-trace\-ascii\fP. +.IP "\-H, \-\-header
" +(HTTP IMAP SMTP) Extra header to include in information sent. When used within an HTTP request, +it is added to the regular request headers. + +For an IMAP or SMTP MIME uploaded mail built with \fI\-F, \-\-form\fP options, it is +prepended to the resulting MIME document, effectively including it at the mail +global level. It does not affect raw uploaded mails. + +You may specify any number of extra headers. Note that if you should add a +custom header that has the same name as one of the internal ones curl would +use, your externally set header is used instead of the internal one. This +allows you to make even trickier stuff than curl would normally do. You should +not replace internally set headers without knowing perfectly well what you are +doing. Remove an internal header by giving a replacement without content on +the right side of the colon, as in: \-H "Host:". If you send the custom header +with no\-value then its header must be terminated with a semicolon, such as \-H +\&"X\-Custom\-Header;" to send "X\-Custom\-Header:". + +curl makes sure that each header you add/replace is sent with the proper +end\-of\-line marker, you should thus \fBnot\fP add that as a part of the header +content: do not add newlines or carriage returns, they only mess things up for +you. curl passes on the verbatim string you give it without any filter or +other safe guards. That includes white space and control characters. + +This option can take an argument in @filename style, which then adds a header +for each line in the input file. Using @\- makes curl read the header file from +stdin. + +Please note that most anti\-spam utilities check the presence and value of +several MIME mail headers: these are "From:", "To:", "Date:" and "Subject:" +among others and should be added with this option. + +You need \fI\-\-proxy\-header\fP to send custom headers intended for an HTTP proxy. + + +Passing on a "Transfer\-Encoding: chunked" header when doing an HTTP request +with a request body, makes curl send the data using chunked encoding. + +\fBWARNING\fP: headers set with this option are set in all HTTP requests \- even +after redirects are followed, like when told with \fI\-L, \-\-location\fP. This can lead to +the header being sent to other hosts than the original host, so sensitive +headers should be used with caution combined with following redirects. + +\&"Authorization:" and "Cookie:" headers are explicitly \fInot\fP passed on in HTTP +requests when following redirects to other origins, unless \fI\-\-location\-trusted\fP +is used. + +--header can be used several times in a command line + +Examples: +.nf +curl -H "X-First-Name: Joe" https://example.com +curl -H "User-Agent: yes-please/2000" https://example.com +curl -H "Host:" https://example.com +curl -H @headers.txt https://example.com +.fi + +See also \fI-A, \-\-user\-agent\fP and \fI-e, \-\-referer\fP. +.IP "\-h, \-\-help " +Usage help. Provide help for the subject given as an optional argument. + +If no argument is provided, curl displays the most important command line +arguments. + +The argument can either be a \fBcategory\fP or a \fBcommand line option\fP. When a +category is provided, curl shows all command line options within the given +category. Specify category "all" to list all available options. + +If "category" is specified, curl displays all available help categories. + +If the provided subject is instead an existing command line option, specified +either in its short form with a single dash and a single letter, or in the +long form with two dashes and a longer name, curl displays a help text for +that option in the terminal. + +The help output is extensive for some options. + +If the provided command line option is not known, curl says so. + +Examples: +.nf +curl --help all +curl --help --insecure +curl --help -f +.fi + +See also \fI-v, \-\-verbose\fP. +.IP "\-\-hostpubmd5 " +(SFTP SCP) Pass a string containing 32 hexadecimal digits. The string should be the 128 +bit \fBMD5\fP checksum of the remote host\(aqs public key, curl refuses the +connection with the host unless the checksums match. + +If --hostpubmd5 is provided several times, the last set value is used. + +Example: +.nf +curl --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/ +.fi + +See also \fI\-\-hostpubsha256\fP. +.IP "\-\-hostpubsha256 " +(SFTP SCP) Pass a string containing a Base64\-encoded SHA256 hash of the remote host\(aqs +public key. curl refuses the connection with the host unless the hashes match. + +This feature requires libcurl to be built with libssh2 and does not work with +other SSH backends. + +If --hostpubsha256 is provided several times, the last set value is used. + +Example: +.nf +curl --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/ +.fi + +Added in 7.80.0. See also \fI\-\-hostpubmd5\fP. +.IP "\-\-hsts " +(HTTPS) Enable HSTS for the transfer. If the filename points to an existing HSTS cache +file, that is used. After a completed transfer, the cache is saved to the +filename again if it has been modified. + +If curl is told to use HTTP:// for a transfer involving a hostname that exists +in the HSTS cache, it upgrades the transfer to use HTTPS. Each HSTS cache +entry has an individual lifetime after which the upgrade is no longer +performed. + +Specify a "" filename (zero length) to avoid loading/saving and make curl just +handle HSTS in memory. + +If this option is used several times, curl loads contents from all the +files but the last one is used for saving. + +--hsts can be used several times in a command line + +Example: +.nf +curl --hsts cache.txt https://example.com +.fi + +Added in 7.74.0. See also \fI\-\-proto\fP. +.IP "\-\-http0.9" +(HTTP) Accept an HTTP version 0.9 response. + +HTTP/0.9 is a response without headers and therefore you can also connect with +this to non\-HTTP servers and still get a response since curl simply +transparently downgrades \- if allowed. + +HTTP/0.9 is disabled by default (added in 7.66.0) + +Providing --http0.9 multiple times has no extra effect. +Disable it again with \-\-no-http0.9. + +Example: +.nf +curl --http0.9 https://example.com +.fi + +Added in 7.64.0. See also \fI\-\-http1.1\fP, \fI\-\-http2\fP and \fI\-\-http3\fP. +.IP "\-0, \-\-http1.0" +(HTTP) Use HTTP version 1.0 instead of using its internally preferred HTTP version. + +Providing --http1.0 multiple times has no extra effect. + +Example: +.nf +curl --http1.0 https://example.com +.fi + +This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP. +See also \fI\-\-http0.9\fP and \fI\-\-http1.1\fP. +.IP "\-\-http1.1" +(HTTP) Use HTTP version 1.1. This is the default with HTTP:// URLs. + +Providing --http1.1 multiple times has no extra effect. + +Example: +.nf +curl --http1.1 https://example.com +.fi + +This option is mutually exclusive with \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP. +See also \fI\-\-http1.0\fP and \fI\-\-http0.9\fP. +.IP "\-\-http2" +(HTTP) Use HTTP/2. + +For HTTPS, this means curl negotiates HTTP/2 in the TLS handshake. curl does +this by default. + +For HTTP, this means curl attempts to upgrade the request to HTTP/2 using the +Upgrade: request header. + +When curl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or +higher even though that is required by the specification. A user can add this +version requirement with \fI\-\-tlsv1.2\fP. + +Providing --http2 multiple times has no extra effect. + +Example: +.nf +curl --http2 https://example.com +.fi + +\fI\-\-http2\fP requires that libcurl is built to support HTTP/2. +This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP. +See also \fI\-\-http1.1\fP, \fI\-\-http3\fP and \fI\-\-no\-alpn\fP. +.IP "\-\-http2\-prior\-knowledge" +(HTTP) Issue a non\-TLS HTTP request using HTTP/2 directly without HTTP/1.1 Upgrade. +It requires prior knowledge that the server supports HTTP/2 straight away. +HTTPS requests still do HTTP/2 the standard way with negotiated protocol +versions in the TLS handshake. + +Since 8.10.0 if this option is set for an HTTPS request then the application +layer protocol version (ALPN) offered to the server is only HTTP/2. Prior to +that both HTTP/1.1 and HTTP/2 were offered. + +Providing --http2-prior-knowledge multiple times has no extra effect. +Disable it again with \-\-no-http2-prior-knowledge. + +Example: +.nf +curl --http2-prior-knowledge https://example.com +.fi + +\fI\-\-http2\-prior\-knowledge\fP requires that libcurl is built to support HTTP/2. +This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP and \fI\-\-http3\fP. +See also \fI\-\-http2\fP and \fI\-\-http3\fP. +.IP "\-\-http3" +(HTTP) Attempt HTTP/3 to the host in the URL, but fallback to earlier HTTP versions +if the HTTP/3 connection establishment fails or is slow. HTTP/3 is only +available for HTTPS and not for HTTP URLs. + +This option allows a user to avoid using the Alt\-Svc method of upgrading to +HTTP/3 when you know or suspect that the target speaks HTTP/3 on the given +host and port. + +When asked to use HTTP/3, curl issues a separate attempt to use older HTTP +versions with a slight delay, so if the HTTP/3 transfer fails or is slow, curl +still tries to proceed with an older HTTP version. The fallback performs the +regular negotiation between HTTP/1 and HTTP/2. + +Use \fI\-\-http3\-only\fP for similar functionality \fIwithout\fP a fallback. + +Providing --http3 multiple times has no extra effect. + +Example: +.nf +curl --http3 https://example.com +.fi + +\fI\-\-http3\fP requires that libcurl is built to support HTTP/3. +This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\-only\fP. +Added in 7.66.0. See also \fI\-\-http1.1\fP and \fI\-\-http2\fP. +.IP "\-\-http3\-only" +(HTTP) Instruct curl to use HTTP/3 to the host in the URL, with no fallback to +earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP +URLs. For HTTP, this option triggers an error. + +This option allows a user to avoid using the Alt\-Svc method of upgrading to +HTTP/3 when you know that the target speaks HTTP/3 on the given host and port. + +This option makes curl fail if a QUIC connection cannot be established, it +does not attempt any other HTTP versions on its own. Use \fI\-\-http3\fP for similar +functionality \fIwith\fP a fallback. + +Providing --http3-only multiple times has no extra effect. + +Example: +.nf +curl --http3-only https://example.com +.fi + +\fI\-\-http3\-only\fP requires that libcurl is built to support HTTP/3. +This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP. +Added in 7.88.0. See also \fI\-\-http1.1\fP, \fI\-\-http2\fP and \fI\-\-http3\fP. +.IP "\-\-ignore\-content\-length" +(FTP HTTP) For HTTP, ignore the Content\-Length header. This is particularly useful for +servers running Apache 1.x, which reports incorrect Content\-Length for files +larger than 2 gigabytes. + +For FTP, this makes curl skip the SIZE command to figure out the size before +downloading a file. + +Providing --ignore-content-length multiple times has no extra effect. +Disable it again with \-\-no-ignore-content-length. + +Example: +.nf +curl --ignore-content-length https://example.com +.fi + +See also \fI\-\-ftp\-skip\-pasv\-ip\fP. +.IP "\-k, \-\-insecure" +(TLS SFTP SCP) By default, every secure connection curl makes is verified to be secure before +the transfer takes place. This option makes curl skip the verification step +and proceed without checking. + +When this option is not used for protocols using TLS, curl verifies the +server\(aqs TLS certificate before it continues: that the certificate contains +the right name which matches the hostname used in the URL and that the +certificate has been signed by a CA certificate present in the cert store. See +this online resource for further details: +\fBhttps://curl.se/docs/sslcerts.html\fP + +For SFTP and SCP, this option makes curl skip the \fIknown_hosts\fP verification. +\fIknown_hosts\fP is a file normally stored in the user\(aqs home directory in the +\&".ssh" subdirectory, which contains hostnames and their public keys. + +\fBWARNING\fP: using this option makes the transfer insecure. + +When curl uses secure protocols it trusts responses and allows for example +HSTS and Alt\-Svc information to be stored and used subsequently. Using +\fI\-k, \-\-insecure\fP can make curl trust and use such information from malicious +servers. + +Providing --insecure multiple times has no extra effect. +Disable it again with \-\-no-insecure. + +Example: +.nf +curl --insecure https://example.com +.fi + +See also \fI\-\-proxy\-insecure\fP, \fI\-\-cacert\fP and \fI\-\-capath\fP. +.IP "\-\-interface " +Perform the operation using a specified interface. You can enter interface +name, IP address or hostname. If you prefer to be specific, you can use the +following special syntax: +.RS +.IP if! +Interface name. If the provided name does not match an existing interface, +curl returns with error 45. +.IP host! +IP address or hostname. +.IP ifhost!! +Interface name and IP address or hostname. This syntax requires libcurl 8.9.0 +or later. + +If the provided name does not match an existing interface, curl returns with +error 45. +.RE +.IP +curl does not support using network interface names for this option on +Windows. + +That name resolve operation if a hostname is provided does \fBnot\fP use +DNS\-over\-HTTPS even if \fI\-\-doh\-url\fP is set. + +On Linux this option can be used to specify a \fBVRF\fP (Virtual Routing and +Forwarding) device, but the binary then needs to either have the +\fBCAP_NET_RAW\fP capability set or to be run as root. + +If --interface is provided several times, the last set value is used. + +Examples: +.nf +curl --interface eth0 https://example.com +curl --interface "host!10.0.0.1" https://example.com +curl --interface "if!enp3s0" https://example.com +.fi + +See also \fI\-\-dns\-interface\fP. +.IP "\-\-ip\-tos " +(All) Set Type of Service (TOS) for IPv4 or Traffic Class for IPv6. + +The values allowed for can be a numeric value between 1 and 255 +or one of the following: + +CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13, AF21, AF22, AF23, +AF31, AF32, AF33, AF41, AF42, AF43, EF, VOICE\-ADMIT, ECT1, ECT0, CE, LE, +LOWCOST, LOWDELAY, THROUGHPUT, RELIABILITY, MINCOST + +If --ip-tos is provided several times, the last set value is used. + +Example: +.nf +curl --ip-tos CS5 https://example.com +.fi + +Added in 8.9.0. See also \fI\-\-tcp\-nodelay\fP and \fI\-\-vlan\-priority\fP. +.IP "\-\-ipfs\-gateway " +(IPFS) Specify which gateway to use for IPFS and IPNS URLs. Not specifying this +instead makes curl check if the IPFS_GATEWAY environment variable is set, or +if a "~/.ipfs/gateway" file holding the gateway URL exists. + +If you run a local IPFS node, this gateway is by default available under +\&"http://localhost:8080". A full example URL would look like: + +.nf +curl \--ipfs\-gateway http://localhost:8080 \\ + ipfs://bafybeigagd5nmnn2iys2f3 +.fi + +There are many public IPFS gateways. See for example: +https://ipfs.github.io/public\-gateway\-checker/ + +If you opt to go for a remote gateway you need to be aware that you completely +trust the gateway. This might be fine in local gateways that you host +yourself. With remote gateways there could potentially be malicious actors +returning you data that does not match the request you made, inspect or even +interfere with the request. You may not notice this when using curl. A +mitigation could be to go for a "trustless" gateway. This means you locally +verify the data. Consult the docs page on trusted vs trustless: +https://docs.ipfs.tech/reference/http/gateway/#trusted\-vs\-trustless + +If --ipfs-gateway is provided several times, the last set value is used. + +Example: +.nf +curl --ipfs-gateway https://example.com ipfs:// +.fi + +Added in 8.4.0. See also \fI-h, \-\-help\fP and \fI-M, \-\-manual\fP. +.IP "\-4, \-\-ipv4" +Use IPv4 addresses only when resolving hostnames, and not for example try +IPv6. + +Providing --ipv4 multiple times has no extra effect. + +Example: +.nf +curl --ipv4 https://example.com +.fi + +This option is mutually exclusive with \fI-6, \-\-ipv6\fP. +See also \fI\-\-http1.1\fP and \fI\-\-http2\fP. +.IP "\-6, \-\-ipv6" +Use IPv6 addresses only when resolving hostnames, and not for example try +IPv4. + +Your resolver may respond to an IPv6\-only resolve request by returning IPv6 +addresses that contain "mapped" IPv4 addresses for compatibility purposes. +macOS is known to do this. + +Providing --ipv6 multiple times has no extra effect. + +Example: +.nf +curl --ipv6 https://example.com +.fi + +This option is mutually exclusive with \fI-4, \-\-ipv4\fP. +See also \fI\-\-http1.1\fP and \fI\-\-http2\fP. +.IP "\-\-json " +(HTTP) Send the specified JSON data in a POST request to the HTTP server. \fI\-\-json\fP +works as a shortcut for passing on these three options: + +.nf +-\-data\-binary [arg] +-\-header "Content\-Type: application/json" +-\-header "Accept: application/json" +.fi + +There is \fBno verification\fP that the passed in data is actual JSON or that +the syntax is correct. + +If you start the data with the letter @, the rest should be a filename to read +the data from, or a single dash (\-) if you want curl to read the data from +stdin. Posting data from a file named \(aqfoobar\(aq would thus be done with \fI\-\-json\fP +@foobar and to instead read the data from stdin, use \fI\-\-json\fP @\-. + +If this option is used more than once on the same command line, the additional +data pieces are concatenated to the previous before sending. + +The headers this option sets can be overridden with \fI\-H, \-\-header\fP as usual. + +--json can be used several times in a command line + +Examples: +.nf +curl --json '{ "drink": "coffee" }' https://example.com +curl --json '{ "drink":' --json ' "coffee" }' https://example.com +curl --json @prepared https://example.com +curl --json @- https://example.com < json.txt +.fi + +This option is mutually exclusive with \fI-F, \-\-form\fP, \fI-I, \-\-head\fP and \fI-T, \-\-upload\-file\fP. +Added in 7.82.0. See also \fI\-\-data\-binary\fP and \fI\-\-data\-raw\fP. +.IP "\-j, \-\-junk\-session\-cookies" +(HTTP) When curl is told to read cookies from a given file, this option makes it +discard all "session cookies". This has the same effect as if a new session is +started. Typical browsers discard session cookies when they are closed down. + +Providing --junk-session-cookies multiple times has no extra effect. +Disable it again with \-\-no-junk-session-cookies. + +Example: +.nf +curl --junk-session-cookies -b cookies.txt https://example.com +.fi + +See also \fI-b, \-\-cookie\fP and \fI-c, \-\-cookie\-jar\fP. +.IP "\-\-keepalive\-cnt " +Set the maximum number of keepalive probes TCP should send but get no response +before dropping the connection. This option is usually used in conjunction +with \fI\-\-keepalive\-time\fP. + +This option is supported on Linux, *BSD/macOS, Windows >=10.0.16299, Solaris +11.4, and recent AIX, HP\-UX and more. This option has no effect if +\fI\-\-no\-keepalive\fP is used. + +If unspecified, the option defaults to 9. + +If --keepalive-cnt is provided several times, the last set value is used. + +Example: +.nf +curl --keepalive-cnt 3 https://example.com +.fi + +Added in 8.9.0. See also \fI\-\-keepalive\-time\fP and \fI\-\-no\-keepalive\fP. +.IP "\-\-keepalive\-time " +Set the time a connection needs to remain idle before sending keepalive probes +and the time between individual keepalive probes. It is currently effective on +operating systems offering the "TCP_KEEPIDLE" and "TCP_KEEPINTVL" socket +options (meaning Linux, *BSD/macOS, Windows, Solaris, and recent AIX, HP\-UX and more). +Keepalive is used by the TCP stack to detect broken networks on idle connections. +The number of missed keepalive probes before declaring the connection down is OS +dependent and is commonly 8 (*BSD/macOS/AIX), 9 (Linux/AIX) or 5/10 (Windows), and +this number can be changed by specifying the curl option "keepalive\-cnt". +Note that this option has no effect if \fI\-\-no\-keepalive\fP is used. + +If unspecified, the option defaults to 60 seconds. + +If --keepalive-time is provided several times, the last set value is used. + +Example: +.nf +curl --keepalive-time 20 https://example.com +.fi + +See also \fI\-\-no\-keepalive\fP, \fI\-\-keepalive\-cnt\fP and \fI-m, \-\-max\-time\fP. +.IP "\-\-key " +(TLS SSH) Private key filename. Allows you to provide your private key in this separate +file. For SSH, if not specified, curl tries the following candidates in order: +\&"~/.ssh/id_rsa", "~/.ssh/id_dsa", "./id_rsa", "./id_dsa". + +If curl is built against OpenSSL library, and the engine pkcs11 or pkcs11 +provider is available, then a PKCS#11 URI (RFC 7512) can be used to specify a +private key located in a PKCS#11 device. A string beginning with "pkcs11:" is +interpreted as a PKCS#11 URI. If a PKCS#11 URI is provided, then the \fI\-\-engine\fP +option is set as "pkcs11" if none was provided and the \fI\-\-key\-type\fP option is +set as "ENG" or "PROV" if none was provided (depending on OpenSSL version). + +If curl is built against Schannel then this option is ignored for TLS +protocols (HTTPS, etc). That backend expects the private key to be already +present in the keychain or PKCS#12 file containing the certificate. + +If --key is provided several times, the last set value is used. + +Example: +.nf +curl --cert certificate --key here https://example.com +.fi + +See also \fI\-\-key\-type\fP and \fI-E, \-\-cert\fP. +.IP "\-\-key\-type " +(TLS) Private key file type. Specify which type your \fI\-\-key\fP provided private key +is. DER, PEM, and ENG are supported. If not specified, PEM is assumed. + +If --key-type is provided several times, the last set value is used. + +Example: +.nf +curl --key-type DER --key here https://example.com +.fi + +See also \fI\-\-key\fP. +.IP "\-\-krb " +(FTP) Enable Kerberos authentication and use. The level must be entered and should +be one of \(aqclear\(aq, \(aqsafe\(aq, \(aqconfidential\(aq, or \(aqprivate\(aq. Should you use a +level that is not one of these, \(aqprivate\(aq is used. + +If --krb is provided several times, the last set value is used. + +Example: +.nf +curl --krb clear ftp://example.com/ +.fi + +\fI\-\-krb\fP requires that libcurl is built to support Kerberos. +See also \fI\-\-delegation\fP and \fI\-\-ssl\fP. +.IP "\-\-libcurl " +Append this option to any ordinary curl command line, and you get +libcurl\-using C source code written to the file that does the equivalent of +what your command\-line operation does. + +This option is global and does not need to be specified for each use of --next. + +If --libcurl is provided several times, the last set value is used. + +Example: +.nf +curl --libcurl client.c https://example.com +.fi + +See also \fI-v, \-\-verbose\fP. +.IP "\-\-limit\-rate " +Specify the maximum transfer rate you want curl to use \- for both downloads +and uploads. This feature is useful if you have a limited pipe and you would +like your transfer not to use your entire bandwidth. To make it slower than it +otherwise would be. + +The given speed is measured in bytes/second, unless a suffix is appended. +Appending \(aqk\(aq or \(aqK\(aq counts the number as kilobytes, \(aqm\(aq or \(aqM\(aq makes it +megabytes, while \(aqg\(aq or \(aqG\(aq makes it gigabytes. The suffixes (k, M, G, T, P) +are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G. + +The rate limiting logic works on averaging the transfer speed to no more than +the set threshold over a period of multiple seconds. + +If you also use the \fI\-Y, \-\-speed\-limit\fP option, that option takes precedence and +might cripple the rate\-limiting slightly, to help keep the speed\-limit +logic working. + +If --limit-rate is provided several times, the last set value is used. + +Examples: +.nf +curl --limit-rate 100K https://example.com +curl --limit-rate 1000 https://example.com +curl --limit-rate 10M https://example.com +.fi + +See also \fI\-\-rate\fP, \fI-Y, \-\-speed\-limit\fP and \fI-y, \-\-speed\-time\fP. +.IP "\-l, \-\-list\-only" +(FTP POP3 SFTP FILE) When listing an FTP directory, force a name\-only view. Maybe particularly +useful if the user wants to machine\-parse the contents of an FTP directory +since the normal directory view does not use a standard look or format. When +used like this, the option causes an NLST command to be sent to the server +instead of LIST. + +Note: Some FTP servers list only files in their response to NLST; they do not +include sub\-directories and symbolic links. + +When listing an SFTP directory, this switch forces a name\-only view, one per +line. This is especially useful if the user wants to machine\-parse the +contents of an SFTP directory since the normal directory view provides more +information than just filenames. + +When retrieving a specific email from POP3, this switch forces a LIST command +to be performed instead of RETR. This is particularly useful if the user wants +to see if a specific message\-id exists on the server and what size it is. + +For FILE, this option has no effect yet as directories are always listed in +this mode. + +Note: When combined with \fI\-X, \-\-request\fP, this option can be used to send a UIDL +command instead, so the user may use the email\(aqs unique identifier rather than +its message\-id to make the request. + +Providing --list-only multiple times has no extra effect. +Disable it again with \-\-no-list-only. + +Example: +.nf +curl --list-only ftp://example.com/dir/ +.fi + +See also \fI-Q, \-\-quote\fP and \fI-X, \-\-request\fP. +.IP "\-\-local\-port " +Set a preferred single number or range (FROM\-TO) of local port numbers to use +for the connection(s). Note that port numbers by nature are a scarce resource +so setting this range to something too narrow might cause unnecessary +connection setup failures. + +If --local-port is provided several times, the last set value is used. + +Example: +.nf +curl --local-port 1000-3000 https://example.com +.fi + +See also \fI-g, \-\-globoff\fP. +.IP "\-L, \-\-location" +(HTTP) If the server reports that the requested page has moved to a different +location (indicated with a Location: header and a 3XX response code), this +option makes curl redo the request to the new place. If used together with +\fI\-i, \-\-show\-headers\fP or \fI\-I, \-\-head\fP, headers from all requested pages are shown. + +When authentication is used, or when sending a cookie with "\-H Cookie:", curl +only sends its credentials to the initial host. If a redirect takes curl to a +different host, it does not get the credentials passed on. See +\fI\-\-location\-trusted\fP on how to change this. + +Limit the amount of redirects to follow by using the \fI\-\-max\-redirs\fP option. + +When curl follows a redirect and if the request is a POST, it sends the +following request with a GET if the HTTP response was 301, 302, or 303. If the +response code was any other 3xx code, curl resends the following request using +the same unmodified method. + +You can tell curl to not change POST requests to GET after a 30x response by +using the dedicated options for that: \fI\-\-post301\fP, \fI\-\-post302\fP and \fI\-\-post303\fP. + +The method set with \fI\-X, \-\-request\fP overrides the method curl would otherwise select +to use. + +Providing --location multiple times has no extra effect. +Disable it again with \-\-no-location. + +Example: +.nf +curl -L https://example.com +.fi + +See also \fI\-\-resolve\fP and \fI\-\-alt\-svc\fP. +.IP "\-\-location\-trusted" +(HTTP) Instruct curl to follow HTTP redirects like \fI\-L, \-\-location\fP, but permit curl to +send credentials and other secrets along to other hosts than the initial one. + +This may or may not introduce a security breach if the site redirects you to a +site to which you send this sensitive data to. Another host means that one or +more of hostname, protocol scheme or port number changed. + +This option also allows curl to pass long cookies set explicitly with \fI\-H, \-\-header\fP. + +Providing --location-trusted multiple times has no extra effect. +Disable it again with \-\-no-location-trusted. + +Examples: +.nf +curl --location-trusted -u user:password https://example.com +curl --location-trusted -H "Cookie: session=abc" https://example.com +.fi + +See also \fI-u, \-\-user\fP. +.IP "\-\-login\-options " +(IMAP LDAP POP3 SMTP) Specify the login options to use during server authentication. + +You can use login options to specify protocol specific options that may be +used during authentication. At present only IMAP, POP3 and SMTP support login +options. For more information about login options please see RFC 2384, +RFC 5092 and the IETF draft +https://datatracker.ietf.org/doc/html/draft\-earhart\-url\-smtp\-00 + +Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option, +curl uses the plain (not SASL) "LOGIN IMAP" command even if the server +advertises SASL authentication. Care should be taken in using this option, as +it sends your password over the network in plain text. This does not work if +the IMAP server disables the plain "LOGIN" (e.g. to prevent password +snooping). + +If --login-options is provided several times, the last set value is used. + +Example: +.nf +curl --login-options 'AUTH=*' imap://example.com +.fi + +See also \fI-u, \-\-user\fP. +.IP "\-\-mail\-auth
" +(SMTP) Specify a single address. This is used to specify the authentication address +(identity) of a submitted message that is being relayed to another server. + +If --mail-auth is provided several times, the last set value is used. + +Example: +.nf +curl --mail-auth user@example.com -T mail smtp://example.com/ +.fi + +See also \fI\-\-mail\-rcpt\fP and \fI\-\-mail\-from\fP. +.IP "\-\-mail\-from
" +(SMTP) Specify a single address that the given mail should get sent from. + +If --mail-from is provided several times, the last set value is used. + +Example: +.nf +curl --mail-from user@example.com -T mail smtp://example.com/ +.fi + +See also \fI\-\-mail\-rcpt\fP and \fI\-\-mail\-auth\fP. +.IP "\-\-mail\-rcpt
" +(SMTP) Specify a single email address, username or mailing list name. Repeat this +option several times to send to multiple recipients. + +When performing an address verification (\fBVRFY\fP command), the recipient +should be specified as the username or username and domain (as per Section 3.5 +of RFC 5321). + +When performing a mailing list expand (EXPN command), the recipient should be +specified using the mailing list name, such as "Friends" or "London\-Office". + + +--mail-rcpt can be used several times in a command line + +Example: +.nf +curl --mail-rcpt user@example.net smtp://example.com +.fi + +See also \fI\-\-mail\-rcpt\-allowfails\fP. +.IP "\-\-mail\-rcpt\-allowfails" +(SMTP) When sending data to multiple recipients, by default curl aborts SMTP +conversation if at least one of the recipients causes RCPT TO command to +return an error. + +The default behavior can be changed by passing \fI\-\-mail\-rcpt\-allowfails\fP +command\-line option which makes curl ignore errors and proceed with the +remaining valid recipients. + +If all recipients trigger RCPT TO failures and this flag is specified, curl +still aborts the SMTP conversation and returns the error received from to the +last RCPT TO command. + +Providing --mail-rcpt-allowfails multiple times has no extra effect. +Disable it again with \-\-no-mail-rcpt-allowfails. + +Example: +.nf +curl --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com +.fi + +Added in 7.69.0. See also \fI\-\-mail\-rcpt\fP. +.IP "\-M, \-\-manual" +Manual. Display the huge help text. + +Example: +.nf +curl --manual +.fi + +See also \fI-v, \-\-verbose\fP, \fI\-\-libcurl\fP and \fI\-\-trace\fP. +.IP "\-\-max\-filesize " +(FTP HTTP MQTT) When set to a non\-zero value, it specifies the maximum size (in bytes) of a +file to download. If the file requested is larger than this value, the +transfer does not start and curl returns with exit code 63. + +Setting the maximum value to zero disables the limit. + +A size modifier may be used. For example, Appending \(aqk\(aq or \(aqK\(aq counts the +number as kilobytes, \(aqm\(aq or \(aqM\(aq makes it megabytes, while \(aqg\(aq or \(aqG\(aq makes it +gigabytes. Examples: 200K, 3m and 1G. + +\fBNOTE\fP: before curl 8.4.0, when the file size is not known prior to +download, for such files this option has no effect even if the file transfer +ends up being larger than this given limit. + +Starting with curl 8.4.0, this option aborts the transfer if it reaches the +threshold during transfer. + +If --max-filesize is provided several times, the last set value is used. + +Example: +.nf +curl --max-filesize 100K https://example.com +.fi + +See also \fI\-\-limit\-rate\fP. +.IP "\-\-max\-redirs " +(HTTP) Set the maximum number of redirections to follow. When \fI\-L, \-\-location\fP is used, to +prevent curl from following too many redirects, by default, the limit is +set to 50 redirects. Set this option to \-1 to make it unlimited. + +If --max-redirs is provided several times, the last set value is used. + +Example: +.nf +curl --max-redirs 3 --location https://example.com +.fi + +See also \fI-L, \-\-location\fP. +.IP "\-m, \-\-max\-time " +Set the maximum time in seconds that you allow each transfer to take. Prevents +your batch jobs from hanging for hours due to slow networks or links going +down. This option accepts decimal values. + +If you enable retrying the transfer (\fI\-\-retry\fP) then the maximum time counter is +reset each time the transfer is retried. You can use \fI\-\-retry\-max\-time\fP to limit +the retry time. + +The decimal value needs to be provided using a dot (.) as decimal separator \- +not the local version even if it might be using another separator. + +If --max-time is provided several times, the last set value is used. + +Examples: +.nf +curl --max-time 10 https://example.com +curl --max-time 2.92 https://example.com +.fi + +See also \fI\-\-connect\-timeout\fP and \fI\-\-retry\-max\-time\fP. +.IP "\-\-metalink" +This option was previously used to specify a Metalink resource. Metalink +support is disabled in curl for security reasons (added in 7.78.0). + +If --metalink is provided several times, the last set value is used. + +Example: +.nf +curl --metalink file https://example.com +.fi + +See also \fI-Z, \-\-parallel\fP. +.IP "\-\-mptcp" +Enable the use of Multipath TCP (MPTCP) for connections. MPTCP is an extension +to the standard TCP that allows multiple TCP streams over different network +paths between the same source and destination. This can enhance bandwidth and +improve reliability by using multiple paths simultaneously. + +MPTCP is beneficial in networks where multiple paths exist between clients and +servers, such as mobile networks where a device may switch between WiFi and +cellular data or in wired networks with multiple Internet Service Providers. + +This option is currently only supported on Linux starting from kernel 5.6. Only +TCP connections are modified, hence this option does not affect HTTP/3 (QUIC) +or UDP connections. + +The server curl connects to must also support MPTCP. If not, the connection +seamlessly falls back to TCP. + +Providing --mptcp multiple times has no extra effect. +Disable it again with \-\-no-mptcp. + +Example: +.nf +curl --mptcp https://example.com +.fi + +Added in 8.9.0. See also \fI\-\-tcp\-fastopen\fP. +.IP "\-\-negotiate" +(HTTP) Enable Negotiate (SPNEGO) authentication. + +This option requires a library built with GSS\-API or SSPI support. Use +\fI\-V, \-\-version\fP to see if your curl supports GSS\-API/SSPI or SPNEGO. + +When using this option, you must also provide a fake \fI\-u, \-\-user\fP option to activate +the authentication code properly. Sending a \(aq\-u :\(aq is enough as the username +and password from the \fI\-u, \-\-user\fP option are not actually used. + +Providing --negotiate multiple times has no extra effect. + +Example: +.nf +curl --negotiate -u : https://example.com +.fi + +See also \fI\-\-basic\fP, \fI\-\-ntlm\fP, \fI\-\-anyauth\fP and \fI\-\-proxy\-negotiate\fP. +.IP "\-n, \-\-netrc" +Make curl scan the \fI.netrc\fP file in the user\(aqs home directory for login name +and password. This is typically used for FTP on Unix. If used with HTTP, curl +enables user authentication. See \fInetrc(5)\fP and \fIftp(1)\fP for details on the +file format. curl does not complain if that file does not have the right +permissions (it should be neither world\- nor group\-readable). The environment +variable "HOME" is used to find the home directory. + +The netrc file provides credentials for a hostname independent of which +protocol and port number that are used. + +On Windows two filenames in the home directory are checked: \fI.netrc\fP and +\fI_netrc\fP, preferring the former. Older versions on Windows checked for \fI_netrc\fP +only. + +A quick and simple example of how to setup a \fI.netrc\fP to allow curl to FTP to +the machine host.example.com with username \(aqmyself\(aq and password \(aqsecret\(aq could +look similar to: + +.nf +machine host.example.com +login myself +password secret +.fi + +Providing --netrc multiple times has no extra effect. +Disable it again with \-\-no-netrc. + +Example: +.nf +curl --netrc https://example.com +.fi + +This option is mutually exclusive with \fI\-\-netrc\-file\fP and \fI\-\-netrc\-optional\fP. +See also \fI\-\-netrc\-file\fP, \fI-K, \-\-config\fP and \fI-u, \-\-user\fP. +.IP "\-\-netrc\-file " +Set the netrc file to use. Similar to \fI\-n, \-\-netrc\fP, except that you also provide +the path (absolute or relative). + +It abides by \fI\-\-netrc\-optional\fP if specified. + +If --netrc-file is provided several times, the last set value is used. + +Example: +.nf +curl --netrc-file netrc https://example.com +.fi + +This option is mutually exclusive with \fI-n, \-\-netrc\fP. +See also \fI-n, \-\-netrc\fP, \fI-u, \-\-user\fP and \fI-K, \-\-config\fP. +.IP "\-\-netrc\-optional" +Similar to \fI\-n, \-\-netrc\fP, but this option makes the .netrc usage \fBoptional\fP +and not mandatory as the \fI\-n, \-\-netrc\fP option does. + +Providing --netrc-optional multiple times has no extra effect. +Disable it again with \-\-no-netrc-optional. + +Example: +.nf +curl --netrc-optional https://example.com +.fi + +This option is mutually exclusive with \fI-n, \-\-netrc\fP. +See also \fI\-\-netrc\-file\fP. +.IP "\-:, \-\-next" +Use a separate operation for the following URL and associated options. This +allows you to send several URL requests, each with their own specific options, +for example, such as different usernames or custom requests for each. + +\fI\-:, \-\-next\fP resets all local options and only global ones have their values survive +over to the operation following the \fI\-:, \-\-next\fP instruction. Global options include +\fI\-v, \-\-verbose\fP, \fI\-\-trace\fP, \fI\-\-trace\-ascii\fP and \fI\-\-fail\-early\fP. + +For example, you can do both a GET and a POST in a single command line: + +.nf +curl www1.example.com \--next \-d postthis www2.example.com +.fi + +--next can be used several times in a command line + +Examples: +.nf +curl https://example.com --next -d postthis www2.example.com +curl -I https://example.com --next https://example.net/ +.fi + +See also \fI-Z, \-\-parallel\fP and \fI-K, \-\-config\fP. +.IP "\-\-no\-alpn" +(HTTPS) Disable the ALPN TLS extension. ALPN is enabled by default if libcurl was built +with an SSL library that supports ALPN. ALPN is used by a libcurl that supports +HTTP/2 to negotiate HTTP/2 support with the server during https sessions. + +Note that this is the negated option name documented. You can use \fI\-\-alpn\fP to +enable ALPN. + +Providing --no-alpn multiple times has no extra effect. +Disable it again with \-\-alpn. + +Example: +.nf +curl --no-alpn https://example.com +.fi + +\fI\-\-no\-alpn\fP requires that libcurl is built to support TLS. +See also \fI\-\-no\-npn\fP and \fI\-\-http2\fP. +.IP "\-N, \-\-no\-buffer" +Disable the buffering of the output stream. In normal work situations, curl +uses a standard buffered output stream that has the effect that it outputs the +data in chunks, not necessarily exactly when the data arrives. Using this +option disables that buffering. + +Note that this is the negated option name documented. You can use \fI\-\-buffer\fP to +enable buffering again. + +Providing --no-buffer multiple times has no extra effect. +Disable it again with \-\-buffer. + +Example: +.nf +curl --no-buffer https://example.com +.fi + +See also \fI-#, \-\-progress\-bar\fP. +.IP "\-\-no\-clobber" +When used in conjunction with the \fI\-o, \-\-output\fP, \fI\-J, \-\-remote\-header\-name\fP, +\fI\-O, \-\-remote\-name\fP, or \fI\-\-remote\-name\-all\fP options, curl avoids overwriting files +that already exist. Instead, a dot and a number gets appended to the name of +the file that would be created, up to filename.100 after which it does not +create any file. + +Note that this is the negated option name documented. You can thus use +\fI\-\-clobber\fP to enforce the clobbering, even if \fI\-J, \-\-remote\-header\-name\fP is +specified. + +The \fI\-C, \-\-continue\-at\fP option cannot be used together with \fI\-\-no\-clobber\fP. + +Providing --no-clobber multiple times has no extra effect. +Disable it again with \-\-clobber. + +Example: +.nf +curl --no-clobber --output local/dir/file https://example.com +.fi + +Added in 7.83.0. See also \fI-o, \-\-output\fP and \fI-O, \-\-remote\-name\fP. +.IP "\-\-no\-keepalive" +Disable the use of keepalive messages on the TCP connection. curl otherwise +enables them by default. + +Note that this is the negated option name documented. You can thus use +\fI\-\-keepalive\fP to enforce keepalive. + +Providing --no-keepalive multiple times has no extra effect. +Disable it again with \-\-keepalive. + +Example: +.nf +curl --no-keepalive https://example.com +.fi + +See also \fI\-\-keepalive\-time\fP and \fI\-\-keepalive\-cnt\fP. +.IP "\-\-no\-npn" +(HTTPS) curl never uses NPN, this option has no effect (added in 7.86.0). + +Disable the NPN TLS extension. NPN is enabled by default if libcurl was built +with an SSL library that supports NPN. NPN is used by a libcurl that supports +HTTP/2 to negotiate HTTP/2 support with the server during https sessions. + +Providing --no-npn multiple times has no extra effect. +Disable it again with \-\-npn. + +Example: +.nf +curl --no-npn https://example.com +.fi + +\fI\-\-no\-npn\fP requires that libcurl is built to support TLS. +See also \fI\-\-no\-alpn\fP and \fI\-\-http2\fP. +.IP "\-\-no\-progress\-meter" +Option to switch off the progress meter output without muting or otherwise +affecting warning and informational messages like \fI\-s, \-\-silent\fP does. + +Note that this is the negated option name documented. You can thus use +\fI\-\-progress\-meter\fP to enable the progress meter again. + +Providing --no-progress-meter multiple times has no extra effect. +Disable it again with \-\-progress-meter. + +Example: +.nf +curl --no-progress-meter -o store https://example.com +.fi + +Added in 7.67.0. See also \fI-v, \-\-verbose\fP and \fI-s, \-\-silent\fP. +.IP "\-\-no\-sessionid" +(TLS) Disable curl\(aqs use of SSL session\-ID caching. By default all transfers are +done using the cache. Note that while nothing should ever get hurt by +attempting to reuse SSL session\-IDs, there seem to be broken SSL +implementations in the wild that may require you to disable this in order for +you to succeed. + +Note that this is the negated option name documented. You can thus use +\fI\-\-sessionid\fP to enforce session\-ID caching. + +Providing --no-sessionid multiple times has no extra effect. +Disable it again with \-\-sessionid. + +Example: +.nf +curl --no-sessionid https://example.com +.fi + +See also \fI-k, \-\-insecure\fP. +.IP "\-\-noproxy " +Comma\-separated list of hosts for which not to use a proxy, if one is +specified. The only wildcard is a single "*" character, which matches all +hosts, and effectively disables the proxy. Each name in this list is matched +as either a domain which contains the hostname, or the hostname itself. For +example, "local.com" would match "local.com", "local.com:80", and +\&"www.local.com", but not "www.notlocal.com". + +This option overrides the environment variables that disable the proxy +("no_proxy" and "NO_PROXY"). If there is an environment +variable disabling a proxy, you can set the no proxy list to "" to override +it. + +IP addresses specified to this option can be provided using CIDR notation +(added in 7.86.0): an appended slash and number specifies the number of +network bits out of the address to use in the comparison. For example +\&"192.168.0.0/16" would match all addresses starting with "192.168". + +If --noproxy is provided several times, the last set value is used. + +Example: +.nf +curl --noproxy "www.example" https://example.com +.fi + +See also \fI-x, \-\-proxy\fP. +.IP "\-\-ntlm" +(HTTP) Use NTLM authentication. The NTLM authentication method was designed by +Microsoft and is used by IIS web servers. It is a proprietary protocol, +reverse\-engineered by clever people and implemented in curl based on their +efforts. This kind of behavior should not be endorsed, you should encourage +everyone who uses NTLM to switch to a public and documented authentication +method instead, such as Digest. + +If you want to enable NTLM for your proxy authentication, then use +\fI\-\-proxy\-ntlm\fP. + +Providing --ntlm multiple times has no extra effect. + +Example: +.nf +curl --ntlm -u user:password https://example.com +.fi + +\fI\-\-ntlm\fP requires that libcurl is built to support TLS. +This option is mutually exclusive with \fI\-\-basic\fP, \fI\-\-negotiate\fP, \fI\-\-digest\fP and \fI\-\-anyauth\fP. +See also \fI\-\-proxy\-ntlm\fP. +.IP "\-\-ntlm\-wb" +(HTTP) Deprecated option (added in 8.8.0). + +Enabled NTLM much in the style \fI\-\-ntlm\fP does, but handed over the authentication +to a separate executable that was executed when needed. + +Providing --ntlm-wb multiple times has no extra effect. + +Example: +.nf +curl --ntlm-wb -u user:password https://example.com +.fi + +See also \fI\-\-ntlm\fP and \fI\-\-proxy\-ntlm\fP. +.IP "\-\-oauth2\-bearer " +(IMAP LDAP POP3 SMTP HTTP) Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token +is used in conjunction with the username which can be specified as part of the +\fI\-\-url\fP or \fI\-u, \-\-user\fP options. + +The Bearer Token and username are formatted according to RFC 6750. + +If --oauth2-bearer is provided several times, the last set value is used. + +Example: +.nf +curl --oauth2-bearer "mF_9.B5f-4.1JqM" https://example.com +.fi + +See also \fI\-\-basic\fP, \fI\-\-ntlm\fP and \fI\-\-digest\fP. +.IP "\-o, \-\-output " +Write output to the given file instead of stdout. If you are using globbing to +fetch multiple documents, you should quote the URL and you can use "#" +followed by a number in the filename. That variable is then replaced with the +current string for the URL being fetched. Like in: + +.nf +curl "http://{one,two}.example.com" \-o "file_#1.txt" +.fi + +or use several variables like: + +.nf +curl "http://{site,host}.host[1\-5].example" \-o "#1_#2" +.fi + +You may use this option as many times as the number of URLs you have. For +example, if you specify two URLs on the same command line, you can use it like +this: + +.nf +curl \-o aa example.com \-o bb example.net +.fi + +and the order of the \-o options and the URLs does not matter, just that the +first \-o is for the first URL and so on, so the above command line can also be +written as + +.nf +curl example.com example.net \-o aa \-o bb +.fi + +See also the \fI\-\-create\-dirs\fP option to create the local directories +dynamically. Specifying the output as \(aq\-\(aq (a single dash) passes the output to +stdout. + +To suppress response bodies, you can redirect output to /dev/null: + +.nf +curl example.com \-o /dev/null +.fi + +Or for Windows: + +.nf +curl example.com \-o nul +.fi + +Specify the filename as single minus to force the output to stdout, to +override curl\(aqs internal binary output in terminal prevention: + +.nf +curl https://example.com/jpeg \-o \- +.fi + +--output is associated with a single URL. Use it once per URL when you use several URLs in a command line. + +Examples: +.nf +curl -o file https://example.com +curl "http://{one,two}.example.com" -o "file_#1.txt" +curl "http://{site,host}.host[1-5].example" -o "#1_#2" +curl -o file https://example.com -o file2 https://example.net +.fi + +See also \fI-O, \-\-remote\-name\fP, \fI\-\-remote\-name\-all\fP and \fI-J, \-\-remote\-header\-name\fP. +.IP "\-\-output\-dir " +Specify the directory in which files should be stored, when \fI\-O, \-\-remote\-name\fP or +\fI\-o, \-\-output\fP are used. + +The given output directory is used for all URLs and output options on the +command line, up until the first \fI\-:, \-\-next\fP. + +If the specified target directory does not exist, the operation fails unless +\fI\-\-create\-dirs\fP is also used. + +If --output-dir is provided several times, the last set value is used. + +Example: +.nf +curl --output-dir "tmp" -O https://example.com +.fi + +Added in 7.73.0. See also \fI-O, \-\-remote\-name\fP and \fI-J, \-\-remote\-header\-name\fP. +.IP "\-Z, \-\-parallel" +Make curl perform all transfers in parallel as compared to the regular serial +manner. Parallel transfer means that curl runs up to N concurrent transfers +simultaneously and if there are more than N transfers to handle, it starts new +ones when earlier transfers finish. + +With parallel transfers, the progress meter output is different from when +doing serial transfers, as it then displays the transfer status for multiple +transfers in a single line. + +The maximum amount of concurrent transfers is set with \fI\-\-parallel\-max\fP and it +defaults to 50. + +This option is global and does not need to be specified for each use of --next. + +Providing --parallel multiple times has no extra effect. +Disable it again with \-\-no-parallel. + +Example: +.nf +curl --parallel https://example.com -o file1 https://example.com -o file2 +.fi + +Added in 7.66.0. See also \fI-:, \-\-next\fP, \fI-v, \-\-verbose\fP, \fI\-\-parallel\-max\fP and \fI\-\-parallel\-immediate\fP. +.IP "\-\-parallel\-immediate" +When doing parallel transfers, this option instructs curl to prefer opening up +more connections in parallel at once rather than waiting to see if new +transfers can be added as multiplexed streams on another connection. + +By default, without this option set, curl prefers to wait a little and +multiplex new transfers over existing connections. It keeps the number of +connections low at the expense of risking a slightly slower transfer startup. + +This option is global and does not need to be specified for each use of --next. + +Providing --parallel-immediate multiple times has no extra effect. +Disable it again with \-\-no-parallel-immediate. + +Example: +.nf +curl --parallel-immediate -Z https://example.com -o file1 https://example.com -o file2 +.fi + +Added in 7.68.0. See also \fI-Z, \-\-parallel\fP and \fI\-\-parallel\-max\fP. +.IP "\-\-parallel\-max " +When asked to do parallel transfers, using \fI\-Z, \-\-parallel\fP, this option controls +the maximum amount of transfers to do simultaneously. + +The default is 50. 300 is the largest supported value. + +This option is global and does not need to be specified for each use of --next. + +If --parallel-max is provided several times, the last set value is used. + +Example: +.nf +curl --parallel-max 100 -Z https://example.com ftp://example.com/ +.fi + +Added in 7.66.0. See also \fI-Z, \-\-parallel\fP. +.IP "\-\-pass " +(SSH TLS) Passphrase for the private key used for SSH or TLS. + +If --pass is provided several times, the last set value is used. + +Example: +.nf +curl --pass secret --key file https://example.com +.fi + +See also \fI\-\-key\fP and \fI-u, \-\-user\fP. +.IP "\-\-path\-as\-is" +Do not handle sequences of /../ or /./ in the given URL path. Normally curl +squashes or merges them according to standards but with this option set you +tell it not to do that. + +Providing --path-as-is multiple times has no extra effect. +Disable it again with \-\-no-path-as-is. + +Example: +.nf +curl --path-as-is https://example.com/../../etc/passwd +.fi + +See also \fI\-\-request\-target\fP. +.IP "\-\-pinnedpubkey " +(TLS) Use the specified public key file (or hashes) to verify the peer. This can be +a path to a file which contains a single public key in PEM or DER format, or +any number of base64 encoded sha256 hashes preceded by \(aqsha256//\(aq and +separated by \(aq;\(aq. + +When negotiating a TLS or SSL connection, the server sends a certificate +indicating its identity. A public key is extracted from this certificate and +if it does not exactly match the public key provided to this option, curl +aborts the connection before sending or receiving any data. + +This option is independent of option \fI\-k, \-\-insecure\fP. If you use both options +together then the peer is still verified by public key. + +PEM/DER support: + +OpenSSL and GnuTLS, wolfSSL, +mbedTLS, Schannel + +sha256 support: + +OpenSSL, GnuTLS and wolfSSL, mbedTLS, +Schannel + +Other SSL backends not supported. + +If --pinnedpubkey is provided several times, the last set value is used. + +Examples: +.nf +curl --pinnedpubkey keyfile https://example.com +curl --pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com +.fi + +See also \fI\-\-hostpubsha256\fP. +.IP "\-\-post301" +(HTTP) Respect RFC 7231/6.4.2 and do not convert POST requests into GET requests when +following a 301 redirect. The non\-RFC behavior is ubiquitous in web browsers, +so curl does the conversion by default to maintain consistency. However, a +server may require a POST to remain a POST after such a redirection. This +option is meaningful only when using \fI\-L, \-\-location\fP. + +Providing --post301 multiple times has no extra effect. +Disable it again with \-\-no-post301. + +Example: +.nf +curl --post301 --location -d "data" https://example.com +.fi + +See also \fI\-\-post302\fP, \fI\-\-post303\fP and \fI-L, \-\-location\fP. +.IP "\-\-post302" +(HTTP) Respect RFC 7231/6.4.3 and do not convert POST requests into GET requests when +following a 302 redirect. The non\-RFC behavior is ubiquitous in web browsers, +so curl does the conversion by default to maintain consistency. However, a +server may require a POST to remain a POST after such a redirection. This +option is meaningful only when using \fI\-L, \-\-location\fP. + +Providing --post302 multiple times has no extra effect. +Disable it again with \-\-no-post302. + +Example: +.nf +curl --post302 --location -d "data" https://example.com +.fi + +See also \fI\-\-post301\fP, \fI\-\-post303\fP and \fI-L, \-\-location\fP. +.IP "\-\-post303" +(HTTP) Violate RFC 7231/6.4.4 and do not convert POST requests into GET requests when +following 303 redirect. A server may require a POST to remain a POST after a +303 redirection. This option is meaningful only when using \fI\-L, \-\-location\fP. + +Providing --post303 multiple times has no extra effect. +Disable it again with \-\-no-post303. + +Example: +.nf +curl --post303 --location -d "data" https://example.com +.fi + +See also \fI\-\-post302\fP, \fI\-\-post301\fP and \fI-L, \-\-location\fP. +.IP "\-\-preproxy <[protocol://]host[:port]>" +Use the specified SOCKS proxy before connecting to an HTTP or HTTPS \fI\-x, \-\-proxy\fP. In +such a case curl first connects to the SOCKS proxy and then connects (through +SOCKS) to the HTTP or HTTPS proxy. Hence pre proxy. + +The pre proxy string should be specified with a protocol:// prefix to specify +alternative proxy protocols. Use socks4://, socks4a://, socks5:// or +socks5h:// to request the specific SOCKS version to be used. No protocol +specified makes curl default to SOCKS4. + +If the port number is not specified in the proxy string, it is assumed to be +1080. + +User and password that might be provided in the proxy string are URL decoded +by curl. This allows you to pass in special characters such as @ by using %40 +or pass in a colon with %3a. + +If --preproxy is provided several times, the last set value is used. + +Example: +.nf +curl --preproxy socks5://proxy.example -x http://http.example https://example.com +.fi + +See also \fI-x, \-\-proxy\fP and \fI\-\-socks5\fP. +.IP "\-#, \-\-progress\-bar" +Make curl display transfer progress as a simple progress bar instead of the +standard, more informational, meter. + +This progress bar draws a single line of \(aq#\(aq characters across the screen and +shows a percentage if the transfer size is known. For transfers without a +known size, there is a space ship (\-=o=\-) that moves back and forth but only +while data is being transferred, with a set of flying hash sign symbols on +top. + +This option is global and does not need to be specified for each use of --next. + +Providing --progress-bar multiple times has no extra effect. +Disable it again with \-\-no-progress-bar. + +Example: +.nf +curl -# -O https://example.com +.fi + +See also \fI\-\-styled\-output\fP. +.IP "\-\-proto " +Limit what protocols to allow for transfers. Protocols are evaluated left to +right, are comma separated, and are each a protocol name or \(aqall\(aq, optionally +prefixed by zero or more modifiers. Available modifiers are: +.RS +.IP + +Permit this protocol in addition to protocols already permitted (this is +the default if no modifier is used). +.IP - +Deny this protocol, removing it from the list of protocols already permitted. +.IP = +Permit only this protocol (ignoring the list already permitted), though +subject to later modification by subsequent entries in the comma separated +list. +.RE +.IP +For example: \fI\-\-proto\fP \-ftps uses the default protocols, but disables ftps + +\fI\-\-proto\fP \-all,https,+http only enables http and https + +\fI\-\-proto\fP =http,https also only enables http and https + +Unknown and disabled protocols produce a warning. This allows scripts to +safely rely on being able to disable potentially dangerous protocols, without +relying upon support for that protocol being built into curl to avoid an error. + +This option can be used multiple times, in which case the effect is the same +as concatenating the protocols into one instance of the option. + +If --proto is provided several times, the last set value is used. + +Example: +.nf +curl --proto =http,https,sftp https://example.com +.fi + +See also \fI\-\-proto\-redir\fP and \fI\-\-proto\-default\fP. +.IP "\-\-proto\-default " +Use \fIprotocol\fP for any provided URL missing a scheme. + +An unknown or unsupported protocol causes error \fICURLE_UNSUPPORTED_PROTOCOL\fP. + +This option does not change the default proxy protocol (http). + +Without this option set, curl guesses protocol based on the hostname, see +\fI\-\-url\fP for details. + +If --proto-default is provided several times, the last set value is used. + +Example: +.nf +curl --proto-default https ftp.example.com +.fi + +See also \fI\-\-proto\fP and \fI\-\-proto\-redir\fP. +.IP "\-\-proto\-redir " +Limit what protocols to allow on redirects. Protocols denied by \fI\-\-proto\fP are +not overridden by this option. See \fI\-\-proto\fP for how protocols are represented. + +Example, allow only HTTP and HTTPS on redirect: + +.nf +curl \--proto\-redir \-all,http,https http://example.com +.fi + +By default curl only allows HTTP, HTTPS, FTP and FTPS on redirects +(added in 7.65.2). Specifying \fIall\fP or \fI+all\fP enables all protocols on +redirects, which is not good for security. + +If --proto-redir is provided several times, the last set value is used. + +Example: +.nf +curl --proto-redir =http,https https://example.com +.fi + +See also \fI\-\-proto\fP. +.IP "\-x, \-\-proxy <[protocol://]host[:port]>" +Use the specified proxy. + +The proxy string can be specified with a protocol:// prefix. No protocol +specified or http:// it is treated as an HTTP proxy. Use socks4://, +socks4a://, socks5:// or socks5h:// to request a specific SOCKS version to be +used. + +Unix domain sockets are supported for socks proxy. Set localhost for the host +part. e.g. socks5h://localhost/path/to/socket.sock + +HTTPS proxy support works with the https:// protocol prefix for OpenSSL and +GnuTLS. It also works for mbedTLS, Rustls, Schannel and +wolfSSL (added in 7.87.0). + +Unrecognized and unsupported proxy protocols cause an error. +Ancient curl versions ignored unknown schemes and used http:// instead. + +If the port number is not specified in the proxy string, it is assumed to be +1080. + +This option overrides existing environment variables that set the proxy to +use. If there is an environment variable setting a proxy, you can set proxy to +\&"" to override it. + +All operations that are performed over an HTTP proxy are transparently +converted to HTTP. It means that certain protocol specific operations might +not be available. This is not the case if you can tunnel through the proxy, as +one with the \fI\-p, \-\-proxytunnel\fP option. + +User and password that might be provided in the proxy string are URL decoded +by curl. This allows you to pass in special characters such as @ by using %40 +or pass in a colon with %3a. + +The proxy host can be specified the same way as the proxy environment +variables, including the protocol prefix (http://) and the embedded user + +password. + +When a proxy is used, the active FTP mode as set with \fI\-P, \-\-ftp\-port\fP, cannot be +used. + +Doing FTP over an HTTP proxy without \fI\-p, \-\-proxytunnel\fP makes curl do HTTP with an +FTP URL over the proxy. For such transfers, common FTP specific options do not +work, including \fI\-\-ssl\-reqd\fP and \fI\-\-ftp\-ssl\-control\fP. + +If --proxy is provided several times, the last set value is used. + +Example: +.nf +curl --proxy http://proxy.example https://example.com +.fi + +See also \fI\-\-socks5\fP and \fI\-\-proxy\-basic\fP. +.IP "\-\-proxy\-anyauth" +Automatically pick a suitable authentication method when communicating with +the given HTTP proxy. This might cause an extra request/response round\-trip. + +Providing --proxy-anyauth multiple times has no extra effect. + +Example: +.nf +curl --proxy-anyauth --proxy-user user:passwd -x proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-basic\fP and \fI\-\-proxy\-digest\fP. +.IP "\-\-proxy\-basic" +Use HTTP Basic authentication when communicating with the given proxy. Use +\fI\-\-basic\fP for enabling HTTP Basic with a remote host. Basic is the default +authentication method curl uses with proxies. + +Providing --proxy-basic multiple times has no extra effect. + +Example: +.nf +curl --proxy-basic --proxy-user user:passwd -x proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-anyauth\fP and \fI\-\-proxy\-digest\fP. +.IP "\-\-proxy\-ca\-native" +(TLS) Use the operating system\(aqs native CA store for certificate verification of the +HTTPS proxy. + +This option is independent of other HTTPS proxy CA certificate locations set at +run time or build time. Those locations are searched in addition to the native +CA store. + +Equivalent to \fI\-\-ca\-native\fP but used in HTTPS proxy context. Refer to \fI\-\-ca\-native\fP +for TLS backend limitations. + +Providing --proxy-ca-native multiple times has no extra effect. +Disable it again with \-\-no-proxy-ca-native. + +Example: +.nf +curl --proxy-ca-native https://example.com +.fi + +Added in 8.2.0. See also \fI\-\-ca\-native\fP, \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-proxy\-cacert " +Use the specified certificate file to verify the HTTPS proxy. The file may +contain multiple CA certificates. The certificate(s) must be in PEM format. + +This allows you to use a different trust for the proxy compared to the remote +server connected to via the proxy. + +Equivalent to \fI\-\-cacert\fP but used in HTTPS proxy context. + +If --proxy-cacert is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-cacert CA-file.txt -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-capath\fP, \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-capath " +Same as \fI\-\-capath\fP but used in HTTPS proxy context. + +Use the specified certificate directory to verify the proxy. Multiple paths +can be provided by separating them with colon (":") (e.g. "path1:path2:path3"). The +certificates must be in PEM format, and if curl is built against OpenSSL, the +directory must have been processed using the c_rehash utility supplied with +OpenSSL. Using \fI\-\-proxy\-capath\fP can allow OpenSSL\-powered curl to make +SSL\-connections much more efficiently than using \fI\-\-proxy\-cacert\fP if the +\fI\-\-proxy\-cacert\fP file contains many CA certificates. + +If this option is set, the default capath value is ignored. + +If --proxy-capath is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-capath /local/directory -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-cacert\fP, \fI-x, \-\-proxy\fP, \fI\-\-capath\fP and \fI\-\-dump\-ca\-embed\fP. +.IP "\-\-proxy\-cert " +Use the specified client certificate file when communicating with an HTTPS +proxy. The certificate must be PEM format. If the optional password is not +specified, it is queried for on the terminal. Use \fI\-\-proxy\-key\fP to provide the +private key. + +This option is the equivalent to \fI\-E, \-\-cert\fP but used in HTTPS proxy context. + +If --proxy-cert is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-cert file -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-key\fP and \fI\-\-proxy\-cert\-type\fP. +.IP "\-\-proxy\-cert\-type " +Set type of the provided client certificate when using HTTPS proxy. PEM, DER, +ENG, PROV and P12 are recognized types. + +The default type depends on the TLS backend and is usually PEM. For Schannel +it is P12. If \fI\-\-proxy\-cert\fP is a pkcs11: URI then ENG or PROV is the default +type (depending on OpenSSL version). + +Equivalent to \fI\-\-cert\-type\fP but used in HTTPS proxy context. + +If --proxy-cert-type is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-cert-type PEM --proxy-cert file -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-cert\fP and \fI\-\-proxy\-key\fP. +.IP "\-\-proxy\-ciphers " +(TLS) Same as \fI\-\-ciphers\fP but used in HTTPS proxy context. + +Specify which cipher suites to use in the connection to your HTTPS proxy when +it negotiates TLS 1.2 (1.1, 1.0). The list of ciphers suites must specify +valid ciphers. Read up on cipher suite details on this URL: + +https://curl.se/docs/ssl\-ciphers.html + +If --proxy-ciphers is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-tls13\-ciphers\fP, \fI\-\-ciphers\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-crlfile " +Provide filename for a PEM formatted file with a Certificate Revocation List +that specifies peer certificates that are considered revoked when +communicating with an HTTPS proxy. + +Equivalent to \fI\-\-crlfile\fP but only used in HTTPS proxy context. + +If --proxy-crlfile is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-crlfile rejects.txt -x https://proxy https://example.com +.fi + +See also \fI\-\-crlfile\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-digest" +Use HTTP Digest authentication when communicating with the given proxy. Use +\fI\-\-digest\fP for enabling HTTP Digest with a remote host. + +Providing --proxy-digest multiple times has no extra effect. + +Example: +.nf +curl --proxy-digest --proxy-user user:passwd -x proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-anyauth\fP and \fI\-\-proxy\-basic\fP. +.IP "\-\-proxy\-header
" +(HTTP) Extra header to include in the request when sending HTTP to a proxy. You may +specify any number of extra headers. This is the equivalent option to \fI\-H, \-\-header\fP +but is for proxy communication only like in CONNECT requests when you want a +separate header sent to the proxy to what is sent to the actual remote host. + +curl makes sure that each header you add/replace is sent with the proper +end\-of\-line marker, you should thus \fBnot\fP add that as a part of the header +content: do not add newlines or carriage returns, they only mess things up for +you. + +Headers specified with this option are not included in requests that curl +knows are not to be sent to a proxy. + +This option can take an argument in @filename style, which then adds a header +for each line in the input file. Using @\- makes curl read +the headers from stdin. + +This option can be used multiple times to add/replace/remove multiple headers. + +--proxy-header can be used several times in a command line + +Examples: +.nf +curl --proxy-header "X-First-Name: Joe" -x http://proxy https://example.com +curl --proxy-header "User-Agent: surprise" -x http://proxy https://example.com +curl --proxy-header "Host:" -x http://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-http2" +(HTTP) Negotiate HTTP/2 with an HTTPS proxy. The proxy might still only offer HTTP/1 +and then curl sticks to using that version. + +This has no effect for any other kinds of proxies. + +Providing --proxy-http2 multiple times has no extra effect. +Disable it again with \-\-no-proxy-http2. + +Example: +.nf +curl --proxy-http2 -x proxy https://example.com +.fi + +\fI\-\-proxy\-http2\fP requires that libcurl is built to support HTTP/2. +Added in 8.1.0. See also \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-insecure" +Same as \fI\-k, \-\-insecure\fP but used in HTTPS proxy context. + +Every secure connection curl makes is verified to be secure before the +transfer takes place. This option makes curl skip the verification step with a +proxy and proceed without checking. + +When this option is not used for a proxy using HTTPS, curl verifies the +proxy\(aqs TLS certificate before it continues: that the certificate contains the +right name which matches the hostname and that the certificate has been signed +by a CA certificate present in the cert store. See this online resource for +further details: \fBhttps://curl.se/docs/sslcerts.html\fP + +\fBWARNING\fP: using this option makes the transfer to the proxy insecure. + +Providing --proxy-insecure multiple times has no extra effect. +Disable it again with \-\-no-proxy-insecure. + +Example: +.nf +curl --proxy-insecure -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-proxy\-key " +Specify the filename for your private key when using client certificates with +your HTTPS proxy. This option is the equivalent to \fI\-\-key\fP but used in HTTPS +proxy context. + +If --proxy-key is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-key here -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-key\-type\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-key\-type " +Specify the private key file type your \fI\-\-proxy\-key\fP provided private key uses. +DER, PEM, and ENG are supported. If not specified, PEM is assumed. + +Equivalent to \fI\-\-key\-type\fP but used in HTTPS proxy context. + +If --proxy-key-type is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-key-type DER --proxy-key here -x https://proxy https://example.com +.fi + +See also \fI\-\-proxy\-key\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-negotiate" +Use HTTP Negotiate (SPNEGO) authentication when communicating with the given +proxy. Use \fI\-\-negotiate\fP for enabling HTTP Negotiate (SPNEGO) with a remote +host. + +Providing --proxy-negotiate multiple times has no extra effect. + +Example: +.nf +curl --proxy-negotiate --proxy-user user:passwd -x proxy https://example.com +.fi + +See also \fI\-\-proxy\-anyauth\fP, \fI\-\-proxy\-basic\fP and \fI\-\-proxy\-service\-name\fP. +.IP "\-\-proxy\-ntlm" +Use HTTP NTLM authentication when communicating with the given proxy. Use +\fI\-\-ntlm\fP for enabling NTLM with a remote host. + +Providing --proxy-ntlm multiple times has no extra effect. + +Example: +.nf +curl --proxy-ntlm --proxy-user user:passwd -x http://proxy https://example.com +.fi + +See also \fI\-\-proxy\-negotiate\fP, \fI\-\-proxy\-anyauth\fP and \fI-U, \-\-proxy\-user\fP. +.IP "\-\-proxy\-pass " +Passphrase for the private key for HTTPS proxy client certificate. + +Equivalent to \fI\-\-pass\fP but used in HTTPS proxy context. + +If --proxy-pass is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-pass secret --proxy-key here -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-key\fP. +.IP "\-\-proxy\-pinnedpubkey " +(TLS) Use the specified public key file (or hashes) to verify the proxy. This can be +a path to a file which contains a single public key in PEM or DER format, or +any number of base64 encoded sha256 hashes preceded by \(aqsha256//\(aq and +separated by \(aq;\(aq. + +When negotiating a TLS or SSL connection, the server sends a certificate +indicating its identity. A public key is extracted from this certificate and +if it does not exactly match the public key provided to this option, curl +aborts the connection before sending or receiving any data. + +Before curl 8.10.0 this option did not work due to a bug. + +If --proxy-pinnedpubkey is provided several times, the last set value is used. + +Examples: +.nf +curl --proxy-pinnedpubkey keyfile https://example.com +curl --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com +.fi + +See also \fI\-\-pinnedpubkey\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-service\-name " +Set the service name for SPNEGO when doing proxy authentication. + +If --proxy-service-name is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-service-name "shrubbery" -x proxy https://example.com +.fi + +See also \fI\-\-service\-name\fP, \fI-x, \-\-proxy\fP and \fI\-\-proxy\-negotiate\fP. +.IP "\-\-proxy\-ssl\-allow\-beast" +Do not work around a security flaw in the TLS1.0 protocol known as BEAST when +communicating to an HTTPS proxy. If this option is not used, the TLS layer may +use workarounds known to cause interoperability problems with some older +server implementations. + +This option only changes how curl does TLS 1.0 with an HTTPS proxy and has no +effect on later TLS versions. + +\fBWARNING\fP: this option loosens the TLS security, and by using this flag you +ask for exactly that. + +Equivalent to \fI\-\-ssl\-allow\-beast\fP but used in HTTPS proxy context. + +Providing --proxy-ssl-allow-beast multiple times has no extra effect. +Disable it again with \-\-no-proxy-ssl-allow-beast. + +Example: +.nf +curl --proxy-ssl-allow-beast -x https://proxy https://example.com +.fi + +See also \fI\-\-ssl\-allow\-beast\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-ssl\-auto\-client\-cert" +Same as \fI\-\-ssl\-auto\-client\-cert\fP but used in HTTPS proxy context. + +This is only supported by Schannel. + +Providing --proxy-ssl-auto-client-cert multiple times has no extra effect. +Disable it again with \-\-no-proxy-ssl-auto-client-cert. + +Example: +.nf +curl --proxy-ssl-auto-client-cert -x https://proxy https://example.com +.fi + +Added in 7.77.0. See also \fI\-\-ssl\-auto\-client\-cert\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-tls13\-ciphers " +(TLS) Same as \fI\-\-tls13\-ciphers\fP but used in HTTPS proxy context. + +Specify which cipher suites to use in the connection to your HTTPS proxy when +it negotiates TLS 1.3. The list of ciphers suites must specify valid ciphers. +Read up on TLS 1.3 cipher suite details on this URL: + +https://curl.se/docs/ssl\-ciphers.html + +This option is used when curl is built to use OpenSSL 1.1.1 or later, +Schannel, wolfSSL, or mbedTLS 3.6.0 or later. + +Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set +by using the \fI\-\-proxy\-ciphers\fP option. + +If --proxy-tls13-ciphers is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy https://example.com +.fi + +Added in 7.61.0. See also \fI\-\-proxy\-ciphers\fP, \fI\-\-tls13\-ciphers\fP and \fI-x, \-\-proxy\fP. +.IP "\-\-proxy\-tlsauthtype " +Set TLS authentication type with HTTPS proxy. The only supported option is +\&"SRP", for TLS\-SRP (RFC 5054). This option works only if the underlying +libcurl is built with TLS\-SRP support. + +Equivalent to \fI\-\-tlsauthtype\fP but used in HTTPS proxy context. + +If --proxy-tlsauthtype is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-tlsauthtype SRP -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-tlsuser\fP and \fI\-\-proxy\-tlspassword\fP. +.IP "\-\-proxy\-tlspassword " +Set password to use with the TLS authentication method specified with +\fI\-\-proxy\-tlsauthtype\fP when using HTTPS proxy. Requires that \fI\-\-proxy\-tlsuser\fP is +set. + +This option does not work with TLS 1.3. + +Equivalent to \fI\-\-tlspassword\fP but used in HTTPS proxy context. + +If --proxy-tlspassword is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-tlspassword passwd -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-tlsuser\fP. +.IP "\-\-proxy\-tlsuser " +Set username for use for HTTPS proxy with the TLS authentication method +specified with \fI\-\-proxy\-tlsauthtype\fP. Requires that \fI\-\-proxy\-tlspassword\fP also is +set. + +This option does not work with TLS 1.3. + +If --proxy-tlsuser is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-tlsuser smith -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-tlspassword\fP. +.IP "\-\-proxy\-tlsv1" +Use at least TLS version 1.x when negotiating with an HTTPS proxy. That means +TLS version 1.0 or higher + +Equivalent to \fI\-1, \-\-tlsv1\fP but for an HTTPS proxy context. + +Providing --proxy-tlsv1 multiple times has no extra effect. + +Example: +.nf +curl --proxy-tlsv1 -x https://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP. +.IP "\-U, \-\-proxy\-user " +Specify the username and password to use for proxy authentication. + +If you use a Windows SSPI\-enabled curl binary and do either Negotiate or NTLM +authentication then you can tell curl to select the username and password from +your environment by specifying a single colon with this option: "\-U :". + +On systems where it works, curl hides the given option argument from process +listings. This is not enough to protect credentials from possibly getting seen +by other users on the same system as they still are visible for a moment +before being cleared. Such sensitive data should be retrieved from a file instead or +similar and never used in clear text in a command line. + +If --proxy-user is provided several times, the last set value is used. + +Example: +.nf +curl --proxy-user smith:secret -x proxy https://example.com +.fi + +See also \fI\-\-proxy\-pass\fP. +.IP "\-\-proxy1.0 " +Use the specified HTTP 1.0 proxy. If the port number is not specified, it is +assumed at port 1080. + +The only difference between this and the HTTP proxy option \fI\-x, \-\-proxy\fP, is that +attempts to use CONNECT through the proxy specifies an HTTP 1.0 protocol +instead of the default HTTP 1.1. + +Providing --proxy1.0 multiple times has no extra effect. + +Example: +.nf +curl --proxy1.0 http://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP, \fI\-\-socks5\fP and \fI\-\-preproxy\fP. +.IP "\-p, \-\-proxytunnel" +When an HTTP proxy is used \fI\-x, \-\-proxy\fP, this option makes curl tunnel the traffic +through the proxy. The tunnel approach is made with the HTTP proxy CONNECT +request and requires that the proxy allows direct connection to the remote port +number curl wants to tunnel through to. + +To suppress proxy CONNECT response headers when curl is set to output headers +use \fI\-\-suppress\-connect\-headers\fP. + +Providing --proxytunnel multiple times has no extra effect. +Disable it again with \-\-no-proxytunnel. + +Example: +.nf +curl --proxytunnel -x http://proxy https://example.com +.fi + +See also \fI-x, \-\-proxy\fP. +.IP "\-\-pubkey " +(SFTP SCP) Public key filename. Allows you to provide your public key in this separate +file. + +curl attempts to automatically extract the public key from the private key +file, so passing this option is generally not required. Note that this public +key extraction requires libcurl to be linked against a copy of libssh2 1.2.8 +or higher that is itself linked against OpenSSL. + +If --pubkey is provided several times, the last set value is used. + +Example: +.nf +curl --pubkey file.pub sftp://example.com/ +.fi + +See also \fI\-\-pass\fP. +.IP "\-Q, \-\-quote " +(FTP SFTP) Send an arbitrary command to the remote FTP or SFTP server. Quote commands are +sent BEFORE the transfer takes place (just after the initial \fBPWD\fP command +in an FTP transfer, to be exact). To make commands take place after a +successful transfer, prefix them with a dash \(aq\-\(aq. + +(FTP only) To make commands be sent after curl has changed the working +directory, just before the file transfer command(s), prefix the command with a +\(aq+\(aq. + +You may specify any number of commands. + +By default curl stops at first failure. To make curl continue even if the +command fails, prefix the command with an asterisk (*). Otherwise, if the +server returns failure for one of the commands, the entire operation is +aborted. + +You must send syntactically correct FTP commands as RFC 959 defines to FTP +servers, or one of the commands listed below to SFTP servers. + +SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands +itself before sending them to the server. Filenames may be quoted shell\-style +to embed spaces or special characters. Following is the list of all supported +SFTP quote commands: +.RS +.IP "atime date file" +The atime command sets the last access time of the file named by the file +operand. The date expression can be all sorts of date strings, see the +\fIcurl_getdate(3)\fP man page for date expression details. (Added in 7.73.0) +.IP "chgrp group file" +The chgrp command sets the group ID of the file named by the file operand to +the group ID specified by the group operand. The group operand is a decimal +integer group ID. +.IP "chmod mode file" +The chmod command modifies the file mode bits of the specified file. The +mode operand is an octal integer mode number. +.IP "chown user file" +The chown command sets the owner of the file named by the file operand to the +user ID specified by the user operand. The user operand is a decimal +integer user ID. +.IP "ln source_file target_file" +The ln and symlink commands create a symbolic link at the target_file location +pointing to the source_file location. +.IP "mkdir directory_name" +The mkdir command creates the directory named by the directory_name operand. +.IP "mtime date file" +The mtime command sets the last modification time of the file named by the +file operand. The date expression can be all sorts of date strings, see the +\fIcurl_getdate(3)\fP man page for date expression details. (Added in 7.73.0) +.IP pwd +The pwd command returns the absolute path name of the current working directory. +.IP "rename source target" +The rename command renames the file or directory named by the source +operand to the destination path named by the target operand. +.IP "rm file" +The rm command removes the file specified by the file operand. +.IP "rmdir directory" +The rmdir command removes the directory entry specified by the directory +operand, provided it is empty. +.IP "symlink source_file target_file" +See ln. +.RE +.IP + +--quote can be used several times in a command line + +Example: +.nf +curl --quote "DELE file" ftp://example.com/foo +.fi + +See also \fI-X, \-\-request\fP. +.IP "\-\-random\-file " +Deprecated option. This option is ignored (added in 7.84.0). Prior to that it +only had an effect on curl if built to use old versions of OpenSSL. + +Specify the path name to file containing random data. The data may be used to +seed the random engine for SSL connections. + +If --random-file is provided several times, the last set value is used. + +Example: +.nf +curl --random-file rubbish https://example.com +.fi + +See also \fI\-\-egd\-file\fP. +.IP "\-r, \-\-range " +(HTTP FTP SFTP FILE) Retrieve a byte range (i.e. a partial document) from an HTTP/1.1, FTP or SFTP +server or a local FILE. Ranges can be specified in a number of ways. +.RS +.IP 0-499 +specifies the first 500 bytes +.IP 500-999 +specifies the second 500 bytes +.IP -500 +specifies the last 500 bytes +.IP 9500- +specifies the bytes from offset 9500 and forward +.IP 0-0,-1 +specifies the first and last byte only(*)(HTTP) +.IP 100-199,500-599 +specifies two separate 100\-byte ranges(*) (HTTP) +.RE +.IP +(*) = NOTE that if specifying multiple ranges and the server supports it then +it replies with a multiple part response that curl returns as\-is. It +contains meta information in addition to the requested bytes. Parsing or +otherwise transforming this response is the responsibility of the caller. + +Only digit characters (0\-9) are valid in the \(aqstart\(aq and \(aqstop\(aq fields of the +\(aqstart\-stop\(aq range syntax. If a non\-digit character is given in the range, the +server\(aqs response is unspecified, depending on the server\(aqs configuration. + +Many HTTP/1.1 servers do not have this feature enabled, so that when you +attempt to get a range, curl instead gets the whole document. + +FTP and SFTP range downloads only support the simple \(aqstart\-stop\(aq syntax +(optionally with one of the numbers omitted). FTP use depends on the extended +FTP command SIZE. + +When using this option for HTTP uploads using POST or PUT, functionality is +not guaranteed. The HTTP protocol has no standard interoperable resume upload +and curl uses a set of headers for this purpose that once proved working for +some servers and have been left for those who find that useful. + +This command line option is mutually exclusive with \fI\-C, \-\-continue\-at\fP: you can only +use one of them for a single transfer. + +If --range is provided several times, the last set value is used. + +Example: +.nf +curl --range 22-44 https://example.com +.fi + +See also \fI-C, \-\-continue\-at\fP and \fI-a, \-\-append\fP. +.IP "\-\-rate " +Specify the maximum transfer frequency you allow curl to use \- in number of +transfer starts per time unit (sometimes called request rate). Without this +option, curl starts the next transfer as fast as possible. + +If given several URLs and a transfer completes faster than the allowed rate, +curl waits until the next transfer is started to maintain the requested +rate. This option has no effect when \fI\-Z, \-\-parallel\fP is used. + +The request rate is provided as "N/U" where N is an integer number and U is a +time unit. Supported units are \(aqs\(aq (second), \(aqm\(aq (minute), \(aqh\(aq (hour) and \(aqd\(aq +/(day, as in a 24 hour unit). The default time unit, if no "/U" is provided, +is number of transfers per hour. + +If curl is told to allow 10 requests per minute, it does not start the next +request until 6 seconds have elapsed since the previous transfer was started. + +This function uses millisecond resolution. If the allowed frequency is set +more than 1000 per second, it instead runs unrestricted. + +When retrying transfers, enabled with \fI\-\-retry\fP, the separate retry delay logic +is used and not this setting. + +Starting in version 8.10.0, you can specify the number of time units in the rate +expression. Make curl do no more than 5 transfers per 15 seconds with "5/15s" +or limit it to 3 transfers per 4 hours with "3/4h". No spaces allowed. + +This option is global and does not need to be specified for each use of --next. + +If --rate is provided several times, the last set value is used. + +Examples: +.nf +curl --rate 2/s https://example.com ... +curl --rate 3/h https://example.com ... +curl --rate 14/m https://example.com ... +.fi + +Added in 7.84.0. See also \fI\-\-limit\-rate\fP and \fI\-\-retry\-delay\fP. +.IP "\-\-raw" +(HTTP) When used, it disables all internal HTTP decoding of content or transfer +encodings and instead makes them passed on unaltered, raw. + +Providing --raw multiple times has no extra effect. +Disable it again with \-\-no-raw. + +Example: +.nf +curl --raw https://example.com +.fi + +See also \fI\-\-tr\-encoding\fP. +.IP "\-e, \-\-referer " +(HTTP) Set the referrer URL in the HTTP request. This can also be set with the +\fI\-H, \-\-header\fP flag of course. When used with \fI\-L, \-\-location\fP you can append ";auto"" to +the \fI\-e, \-\-referer\fP URL to make curl automatically set the previous URL when it +follows a Location: header. The ";auto" string can be used alone, even if you +do not set an initial \fI\-e, \-\-referer\fP. + +If --referer is provided several times, the last set value is used. + +Examples: +.nf +curl --referer "https://fake.example" https://example.com +curl --referer "https://fake.example;auto" -L https://example.com +curl --referer ";auto" -L https://example.com +.fi + +See also \fI-A, \-\-user\-agent\fP and \fI-H, \-\-header\fP. +.IP "\-J, \-\-remote\-header\-name" +(HTTP) Tell the \fI\-O, \-\-remote\-name\fP option to use the server\-specified Content\-Disposition +filename instead of extracting a filename from the URL. If the server\-provided +filename contains a path, that is stripped off before the filename is used. + +The file is saved in the current directory, or in the directory specified with +\fI\-\-output\-dir\fP. + +If the server specifies a filename and a file with that name already exists in +the destination directory, it is not overwritten and an error occurs \- unless +you allow it by using the \fI\-\-clobber\fP option. If the server does not specify a +filename then this option has no effect. + +There is no attempt to decode %\-sequences (yet) in the provided filename, so +this option may provide you with rather unexpected filenames. + +This feature uses the name from the "filename" field, it does not yet support +the "filename*" field (filenames with explicit character sets). + +\fBWARNING\fP: Exercise judicious use of this option, especially on Windows. A +rogue server could send you the name of a DLL or other file that could be +loaded automatically by Windows or some third party software. + +Providing --remote-header-name multiple times has no extra effect. +Disable it again with \-\-no-remote-header-name. + +Example: +.nf +curl -OJ https://example.com/file +.fi + +See also \fI-O, \-\-remote\-name\fP. +.IP "\-O, \-\-remote\-name" +Write output to a local file named like the remote file we get. (Only the file +part of the remote file is used, the path is cut off.) + +The file is saved in the current working directory. If you want the file saved +in a different directory, make sure you change the current working directory +before invoking curl with this option or use \fI\-\-output\-dir\fP. + +The remote filename to use for saving is extracted from the given URL, nothing +else, and if it already exists it is overwritten. If you want the server to be +able to choose the filename refer to \fI\-J, \-\-remote\-header\-name\fP which can be used in +addition to this option. If the server chooses a filename and that name +already exists it is not overwritten. + +There is no URL decoding done on the filename. If it has %20 or other URL +encoded parts of the name, they end up as\-is as filename. + +You may use this option as many times as the number of URLs you have. + +Before curl 8.10.0, curl returned an error if the URL ended with a slash, +which means that there is no filename part in the URL. Starting in 8.10.0, +curl sets the filename to the last directory part of the URL or if that also +is missing to "curl_response" (without extension) for this situation. + +--remote-name is associated with a single URL. Use it once per URL when you use several URLs in a command line. + +Examples: +.nf +curl -O https://example.com/filename +curl -O https://example.com/filename -O https://example.com/file2 +.fi + +See also \fI\-\-remote\-name\-all\fP, \fI\-\-output\-dir\fP and \fI-J, \-\-remote\-header\-name\fP. +.IP "\-\-remote\-name\-all" +Change the default action for all given URLs to be dealt with as if +\fI\-O, \-\-remote\-name\fP were used for each one. If you want to disable that for a +specific URL after \fI\-\-remote\-name\-all\fP has been used, you must use "\-o \-" or +\fI\-\-no\-remote\-name\fP. + +Providing --remote-name-all multiple times has no extra effect. +Disable it again with \-\-no-remote-name-all. + +Example: +.nf +curl --remote-name-all ftp://example.com/file1 ftp://example.com/file2 +.fi + +See also \fI-O, \-\-remote\-name\fP. +.IP "\-R, \-\-remote\-time" +Make curl attempt to figure out the timestamp of the remote file that is +getting downloaded, and if that is available make the local file get that same +timestamp. + +Providing --remote-time multiple times has no extra effect. +Disable it again with \-\-no-remote-time. + +Example: +.nf +curl --remote-time -o foo https://example.com +.fi + +See also \fI-O, \-\-remote\-name\fP and \fI-z, \-\-time\-cond\fP. +.IP "\-\-remove\-on\-error" +Remove the output file if an error occurs. If curl returns an error when told to +save output in a local file. This prevents curl from leaving a partial file in +the case of an error during transfer. + +If the output is not a regular file, this option has no effect. + +The \fI\-C, \-\-continue\-at\fP option cannot be used together with \fI\-\-remove\-on\-error\fP. + +Providing --remove-on-error multiple times has no extra effect. +Disable it again with \-\-no-remove-on-error. + +Example: +.nf +curl --remove-on-error -o output https://example.com +.fi + +Added in 7.83.0. See also \fI-f, \-\-fail\fP. +.IP "\-X, \-\-request " +Change the method to use when starting the transfer. + +curl passes on the verbatim string you give it in the request without any +filter or other safe guards. That includes white space and control characters. +.RS +.IP HTTP +Specifies a custom request method to use when communicating with the HTTP +server. The specified request method is used instead of the method otherwise +used (which defaults to \fIGET\fP). Read the HTTP 1.1 specification for details +and explanations. Common additional HTTP requests include \fIPUT\fP and \fIDELETE\fP, +while related technologies like WebDAV offers \fIPROPFIND\fP, \fICOPY\fP, \fIMOVE\fP and +more. + +Normally you do not need this option. All sorts of \fIGET\fP, \fIHEAD\fP, \fIPOST\fP and +\fIPUT\fP requests are rather invoked by using dedicated command line options. + +This option only changes the actual word used in the HTTP request, it does not +alter the way curl behaves. For example if you want to make a proper HEAD +request, using \-X HEAD does not suffice. You need to use the \fI\-I, \-\-head\fP option. + +The method string you set with \fI\-X, \-\-request\fP is used for all requests, which +if you for example use \fI\-L, \-\-location\fP may cause unintended side\-effects when curl +does not change request method according to the HTTP 30x response codes \- and +similar. +.IP FTP +Specifies a custom FTP command to use instead of \fILIST\fP when doing file lists +with FTP. +.IP POP3 +Specifies a custom POP3 command to use instead of \fILIST\fP or \fIRETR\fP. + +.IP IMAP +Specifies a custom IMAP command to use instead of \fILIST\fP. +.IP SMTP +Specifies a custom SMTP command to use instead of \fIHELP\fP or \fBVRFY\fP. +.RE +.IP + +If --request is provided several times, the last set value is used. + +Examples: +.nf +curl -X "DELETE" https://example.com +curl -X NLST ftp://example.com/ +.fi + +See also \fI\-\-request\-target\fP. +.IP "\-\-request\-target " +(HTTP) Use an alternative target (path) instead of using the path as provided in the +URL. Particularly useful when wanting to issue HTTP requests without leading +slash or other data that does not follow the regular URL pattern, like +\&"OPTIONS *". + +curl passes on the verbatim string you give it in the request without any +filter or other safe guards. That includes white space and control characters. + +If --request-target is provided several times, the last set value is used. + +Example: +.nf +curl --request-target "*" -X OPTIONS https://example.com +.fi + +See also \fI-X, \-\-request\fP. +.IP "\-\-resolve <[+]host:port:addr[,addr]...>" +Provide a custom address for a specific host and port pair. Using this, you +can make the curl requests(s) use a specified address and prevent the +otherwise normally resolved address to be used. Consider it a sort of +/etc/hosts alternative provided on the command line. The port number should be +the number used for the specific protocol the host is used for. It means you +need several entries if you want to provide addresses for the same host but +different ports. + +By specifying "*" as host you can tell curl to resolve any host and specific +port pair to the specified address. Wildcard is resolved last so any \fI\-\-resolve\fP +with a specific host and port is used first. + +The provided address set by this option is used even if \fI\-4, \-\-ipv4\fP or \fI\-6, \-\-ipv6\fP is +set to make curl use another IP version. + +By prefixing the host with a \(aq+\(aq you can make the entry time out after curl\(aqs +default timeout (1 minute). Note that this only makes sense for long running +parallel transfers with a lot of files. In such cases, if this option is used +curl tries to resolve the host as it normally would once the timeout has +expired. + +Provide IPv6 addresses within [brackets]. + +To redirect connects from a specific hostname or any hostname, independently +of port number, consider the \fI\-\-connect\-to\fP option. + +Support for resolving with wildcard was added in 7.64.0. + +Support for the \(aq+\(aq prefix was added in 7.75.0. + +Support for specifying the host component as an IPv6 address was added in 8.13.0. + +--resolve can be used several times in a command line + +Examples: +.nf +curl --resolve example.com:443:127.0.0.1 https://example.com +curl --resolve example.com:443:[2001:db8::252f:efd6] https://example.com +.fi + +See also \fI\-\-connect\-to\fP and \fI\-\-alt\-svc\fP. +.IP "\-\-retry " +If a transient error is returned when curl tries to perform a transfer, it +retries this number of times before giving up. Setting the number to 0 +makes curl do no retries (which is the default). Transient error means either: +a timeout, an FTP 4xx response code or an HTTP 408, 429, 500, 502, 503 or 504 +response code. + +When curl is about to retry a transfer, it first waits one second and then for +all forthcoming retries it doubles the waiting time until it reaches 10 +minutes, which then remains the set fixed delay time between the rest of the +retries. By using \fI\-\-retry\-delay\fP you disable this exponential backoff algorithm. +See also \fI\-\-retry\-max\-time\fP to limit the total time allowed for retries. + +curl complies with the Retry\-After: response header if one was present to know +when to issue the next retry (added in 7.66.0). + +If --retry is provided several times, the last set value is used. + +Example: +.nf +curl --retry 7 https://example.com +.fi + +See also \fI\-\-retry\-max\-time\fP. +.IP "\-\-retry\-all\-errors" +Retry on any error. This option is used together with \fI\-\-retry\fP. + +This option is the "sledgehammer" of retrying. Do not use this option by +default (for example in your \fBcurlrc\fP), there may be unintended consequences +such as sending or receiving duplicate data. Do not use with redirected input +or output. You might be better off handling your unique problems in a shell +script. Please read the example below. + +\fBWARNING\fP: For server compatibility curl attempts to retry failed flaky +transfers as close as possible to how they were started, but this is not +possible with redirected input or output. For example, before retrying it +removes output data from a failed partial transfer that was written to an +output file. However this is not true of data redirected to a | pipe or > +file, which are not reset. We strongly suggest you do not parse or record +output via redirect in combination with this option, since you may receive +duplicate data. + +By default curl does not return an error for transfers with an HTTP response code +that indicates an HTTP error, if the transfer was successful. For example, if +a server replies 404 Not Found and the reply is fully received then that is +not an error. When \fI\-\-retry\fP is used then curl retries on some HTTP response +codes that indicate transient HTTP errors, but that does not include most 4xx +response codes such as 404. If you want to retry on all response codes that +indicate HTTP errors (4xx and 5xx) then combine with \fI\-f, \-\-fail\fP. + +Providing --retry-all-errors multiple times has no extra effect. +Disable it again with \-\-no-retry-all-errors. + +Example: +.nf +curl --retry 5 --retry-all-errors https://example.com +.fi + +Added in 7.71.0. See also \fI\-\-retry\fP. +.IP "\-\-retry\-connrefused" +In addition to the other conditions, consider ECONNREFUSED as a transient +error too for \fI\-\-retry\fP. This option is used together with \fI\-\-retry\fP. + +Providing --retry-connrefused multiple times has no extra effect. +Disable it again with \-\-no-retry-connrefused. + +Example: +.nf +curl --retry-connrefused --retry 7 https://example.com +.fi + +See also \fI\-\-retry\fP and \fI\-\-retry\-all\-errors\fP. +.IP "\-\-retry\-delay " +Make curl sleep this amount of time before each retry when a transfer has +failed with a transient error (it changes the default backoff time algorithm +between retries). This option is only interesting if \fI\-\-retry\fP is also +used. Setting this delay to zero makes curl use the default backoff time. + +If --retry-delay is provided several times, the last set value is used. + +Example: +.nf +curl --retry-delay 5 --retry 7 https://example.com +.fi + +See also \fI\-\-retry\fP. +.IP "\-\-retry\-max\-time " +The retry timer is reset before the first transfer attempt. Retries are done +as usual (see \fI\-\-retry\fP) as long as the timer has not reached this given +limit. Notice that if the timer has not reached the limit, the request is +made and while performing, it may take longer than this given time period. To +limit a single request\(aqs maximum time, use \fI\-m, \-\-max\-time\fP. Set this option to zero +to not timeout retries. + +If --retry-max-time is provided several times, the last set value is used. + +Example: +.nf +curl --retry-max-time 30 --retry 10 https://example.com +.fi + +See also \fI\-\-retry\fP. +.IP "\-\-sasl\-authzid " +Use this authorization identity (\fBauthzid\fP), during SASL PLAIN +authentication, in addition to the authentication identity (\fBauthcid\fP) as +specified by \fI\-u, \-\-user\fP. + +If the option is not specified, the server derives the \fBauthzid\fP from the +\fBauthcid\fP, but if specified, and depending on the server implementation, it +may be used to access another user\(aqs inbox, that the user has been granted +access to, or a shared mailbox for example. + +If --sasl-authzid is provided several times, the last set value is used. + +Example: +.nf +curl --sasl-authzid zid imap://example.com/ +.fi + +Added in 7.66.0. See also \fI\-\-login\-options\fP. +.IP "\-\-sasl\-ir" +Enable initial response in SASL authentication. + +Providing --sasl-ir multiple times has no extra effect. +Disable it again with \-\-no-sasl-ir. + +Example: +.nf +curl --sasl-ir imap://example.com/ +.fi + +See also \fI\-\-sasl\-authzid\fP. +.IP "\-\-service\-name " +Set the service name for SPNEGO. + +If --service-name is provided several times, the last set value is used. + +Example: +.nf +curl --service-name sockd/server https://example.com +.fi + +See also \fI\-\-negotiate\fP and \fI\-\-proxy\-service\-name\fP. +.IP "\-S, \-\-show\-error" +When used with \fI\-s, \-\-silent\fP, it makes curl show an error message if it fails. + +This option is global and does not need to be specified for each use of --next. + +Providing --show-error multiple times has no extra effect. +Disable it again with \-\-no-show-error. + +Example: +.nf +curl --show-error --silent https://example.com +.fi + +See also \fI\-\-no\-progress\-meter\fP. +.IP "\-i, \-\-show\-headers" +(HTTP FTP) Show response headers in the output. HTTP response headers can include things +like server name, cookies, date of the document, HTTP version and more. With +non\-HTTP protocols, the "headers" are other server communication. + +This option makes the response headers get saved in the same stream/output as +the data. \fI\-D, \-\-dump\-header\fP exists to save headers in a separate stream. + +To view the request headers, consider the \fI\-v, \-\-verbose\fP option. + +Prior to 7.75.0 curl did not print the headers if \fI\-f, \-\-fail\fP was used in +combination with this option and there was an error reported by the server. + +This option was called \fI\-\-include\fP before 8.10.0. The previous name remains +functional. + +Providing --show-headers multiple times has no extra effect. +Disable it again with \-\-no-show-headers. + +Example: +.nf +curl -i https://example.com +.fi + +See also \fI-v, \-\-verbose\fP and \fI-D, \-\-dump\-header\fP. +.IP "\-\-sigalgs " +(TLS) Set specific signature algorithms to use during SSL session establishment according to RFC +5246, 7.4.1.4.1. + +An algorithm can use either a signature algorithm and a hash algorithm pair separated by a +\&"+" (e.g. "ECDSA+SHA224"), or its TLS 1.3 signature scheme name (e.g. "ed25519"). + +Multiple algorithms can be provided by separating them with ":" +(e.g. "DSA+SHA256:rsa_pss_pss_sha256"). The parameter is available as "\-sigalgs" in the +OpenSSL "s_client" and "s_server" utilities. + +\&"\fI\-\-sigalgs\fP" allows a OpenSSL powered curl to make SSL\-connections with exactly +the signature algorithms requested by the client, avoiding nontransparent client/server +negotiations. + +If this option is set, the default signature algorithm list built into OpenSSL are ignored. + +If --sigalgs is provided several times, the last set value is used. + +Example: +.nf +curl --sigalgs ecdsa_secp256r1_sha256 https://example.com +.fi + +Added in 8.14.0. See also \fI\-\-ciphers\fP. +.IP "\-s, \-\-silent" +Silent or quiet mode. Do not show progress meter or error messages. Makes curl +mute. It still outputs the data you ask for, potentially even to the +terminal/stdout unless you redirect it. + +Use \fI\-S, \-\-show\-error\fP in addition to this option to disable progress meter but +still show error messages. + +Providing --silent multiple times has no extra effect. +Disable it again with \-\-no-silent. + +Example: +.nf +curl -s https://example.com +.fi + +See also \fI-v, \-\-verbose\fP, \fI\-\-stderr\fP and \fI\-\-no\-progress\-meter\fP. +.IP "\-\-skip\-existing" +If there is a local file present when a download is requested, the operation +is skipped. Note that curl cannot know if the local file was previously +downloaded fine, or if it is incomplete etc, it just knows if there is a +filename present in the file system or not and it skips the transfer if it is. + +Providing --skip-existing multiple times has no extra effect. +Disable it again with \-\-no-skip-existing. + +Example: +.nf +curl --skip-existing --output local/dir/file https://example.com +.fi + +Added in 8.10.0. See also \fI-o, \-\-output\fP, \fI-O, \-\-remote\-name\fP and \fI\-\-no\-clobber\fP. +.IP "\-\-socks4 " +Use the specified SOCKS4 proxy. If the port number is not specified, it is +assumed at port 1080. Using this socket type makes curl resolve the hostname +and pass the address on to the proxy. + +To specify proxy on a Unix domain socket, use localhost for host, e.g. +\&"socks4://localhost/path/to/socket.sock" + +This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually +exclusive. + +This option is superfluous since you can specify a socks4 proxy with \fI\-x, \-\-proxy\fP +using a socks4:// protocol prefix. + +\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time proxy is used +with an HTTP/HTTPS proxy. In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. + +If --socks4 is provided several times, the last set value is used. + +Example: +.nf +curl --socks4 hostname:4096 https://example.com +.fi + +See also \fI\-\-socks4a\fP, \fI\-\-socks5\fP and \fI\-\-socks5\-hostname\fP. +.IP "\-\-socks4a " +Use the specified SOCKS4a proxy. If the port number is not specified, it is +assumed at port 1080. This asks the proxy to resolve the hostname. + +To specify proxy on a Unix domain socket, use localhost for host, e.g. +\&"socks4a://localhost/path/to/socket.sock" + +This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually +exclusive. + +This option is superfluous since you can specify a socks4a proxy with \fI\-x, \-\-proxy\fP +using a socks4a:// protocol prefix. + +\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is +used with an HTTP/HTTPS proxy. In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. + +If --socks4a is provided several times, the last set value is used. + +Example: +.nf +curl --socks4a hostname:4096 https://example.com +.fi + +See also \fI\-\-socks4\fP, \fI\-\-socks5\fP and \fI\-\-socks5\-hostname\fP. +.IP "\-\-socks5 " +Use the specified SOCKS5 proxy \- but resolve the hostname locally. If the +port number is not specified, it is assumed at port 1080. + +To specify proxy on a Unix domain socket, use localhost for host, e.g. +\&"socks5://localhost/path/to/socket.sock" + +This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually +exclusive. + +This option is superfluous since you can specify a socks5 proxy with \fI\-x, \-\-proxy\fP +using a socks5:// protocol prefix. + +\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is +used with an HTTP/HTTPS proxy. In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. + +This option does not work with FTPS or LDAP. + +If --socks5 is provided several times, the last set value is used. + +Example: +.nf +curl --socks5 proxy.example:7000 https://example.com +.fi + +See also \fI\-\-socks5\-hostname\fP and \fI\-\-socks4a\fP. +.IP "\-\-socks5\-basic" +Use username/password authentication when connecting to a SOCKS5 proxy. The +username/password authentication is enabled by default. Use \fI\-\-socks5\-gssapi\fP to +force GSS\-API authentication to SOCKS5 proxies. + +Providing --socks5-basic multiple times has no extra effect. + +Example: +.nf +curl --socks5-basic --socks5 hostname:4096 https://example.com +.fi + +See also \fI\-\-socks5\fP. +.IP "\-\-socks5\-gssapi" +Use GSS\-API authentication when connecting to a SOCKS5 proxy. The GSS\-API +authentication is enabled by default (if curl is compiled with GSS\-API +support). Use \fI\-\-socks5\-basic\fP to force username/password authentication to +SOCKS5 proxies. + +Providing --socks5-gssapi multiple times has no extra effect. +Disable it again with \-\-no-socks5-gssapi. + +Example: +.nf +curl --socks5-gssapi --socks5 hostname:4096 https://example.com +.fi + +See also \fI\-\-socks5\fP. +.IP "\-\-socks5\-gssapi\-nec" +As part of the GSS\-API negotiation a protection mode is negotiated. RFC 1961 +says in section 4.3/4.4 it should be protected, but the NEC reference +implementation does not. The option \fI\-\-socks5\-gssapi\-nec\fP allows the +unprotected exchange of the protection mode negotiation. + +Providing --socks5-gssapi-nec multiple times has no extra effect. +Disable it again with \-\-no-socks5-gssapi-nec. + +Example: +.nf +curl --socks5-gssapi-nec --socks5 hostname:4096 https://example.com +.fi + +See also \fI\-\-socks5\fP. +.IP "\-\-socks5\-gssapi\-service " +Set the service name for a socks server. Default is \fBrcmd/server\-fqdn\fP. + +If --socks5-gssapi-service is provided several times, the last set value is used. + +Example: +.nf +curl --socks5-gssapi-service sockd --socks5 hostname:4096 https://example.com +.fi + +See also \fI\-\-socks5\fP. +.IP "\-\-socks5\-hostname " +Use the specified SOCKS5 proxy (and let the proxy resolve the hostname). If +the port number is not specified, it is assumed at port 1080. + +To specify proxy on a Unix domain socket, use localhost for host, e.g. +\&"socks5h://localhost/path/to/socket.sock" + +This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually +exclusive. + +This option is superfluous since you can specify a socks5 hostname proxy with +\fI\-x, \-\-proxy\fP using a socks5h:// protocol prefix. + +\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is +used with an HTTP/HTTPS proxy. In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. + +If --socks5-hostname is provided several times, the last set value is used. + +Example: +.nf +curl --socks5-hostname proxy.example:7000 https://example.com +.fi + +See also \fI\-\-socks5\fP and \fI\-\-socks4a\fP. +.IP "\-Y, \-\-speed\-limit " +If a transfer is slower than this set speed (in bytes per second) for a given +number of seconds, it gets aborted. The time period is set with \fI\-y, \-\-speed\-time\fP +and is 30 seconds by default. + +If --speed-limit is provided several times, the last set value is used. + +Example: +.nf +curl --speed-limit 300 --speed-time 10 https://example.com +.fi + +See also \fI-y, \-\-speed\-time\fP, \fI\-\-limit\-rate\fP and \fI-m, \-\-max\-time\fP. +.IP "\-y, \-\-speed\-time " +If a transfer runs slower than speed\-limit bytes per second during a +speed\-time period, the transfer is aborted. If speed\-time is used, the default +speed\-limit is 1 unless set with \fI\-Y, \-\-speed\-limit\fP. + +This option controls transfers (in both directions) but does not affect slow +connects etc. If this is a concern for you, try the \fI\-\-connect\-timeout\fP option. + +If --speed-time is provided several times, the last set value is used. + +Example: +.nf +curl --speed-limit 300 --speed-time 10 https://example.com +.fi + +See also \fI-Y, \-\-speed\-limit\fP and \fI\-\-limit\-rate\fP. +.IP "\-\-ssl" +(FTP IMAP POP3 SMTP LDAP) Warning: this is considered an insecure option. Consider using \fI\-\-ssl\-reqd\fP +instead to be sure curl upgrades to a secure connection. + +Try to use SSL/TLS for the connection \- often referred to as STARTTLS or STLS +because of the involved commands. Reverts to a non\-secure connection if the +server does not support SSL/TLS. See also \fI\-\-ftp\-ssl\-control\fP and \fI\-\-ssl\-reqd\fP for +different levels of encryption required. + +This option is handled in LDAP (added in 7.81.0). It is fully supported by the +OpenLDAP backend and ignored by the generic ldap backend. + +Please note that a server may close the connection if the negotiation does +not succeed. + +This option was formerly known as \fI\-\-ftp\-ssl\fP. That option +name can still be used but might be removed in a future version. + +Providing --ssl multiple times has no extra effect. +Disable it again with \-\-no-ssl. + +Example: +.nf +curl --ssl pop3://example.com/ +.fi + +See also \fI\-\-ssl\-reqd\fP, \fI-k, \-\-insecure\fP and \fI\-\-ciphers\fP. +.IP "\-\-ssl\-allow\-beast" +(TLS) Do not work around a security flaw in the TLS1.0 protocol known as BEAST. If +this option is not used, the TLS layer may use workarounds known to cause +interoperability problems with some older server implementations. + +This option only changes how curl does TLS 1.0 and has no effect on later TLS +versions. + +\fBWARNING\fP: this option loosens the TLS security, and by using this flag you +ask for exactly that. + +Providing --ssl-allow-beast multiple times has no extra effect. +Disable it again with \-\-no-ssl-allow-beast. + +Example: +.nf +curl --ssl-allow-beast https://example.com +.fi + +See also \fI\-\-proxy\-ssl\-allow\-beast\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-ssl\-auto\-client\-cert" +(TLS) (Schannel) Automatically locate and use a client certificate for +authentication, when requested by the server. Since the server can request any +certificate that supports client authentication in the OS certificate store it +could be a privacy violation and unexpected. + +Providing --ssl-auto-client-cert multiple times has no extra effect. +Disable it again with \-\-no-ssl-auto-client-cert. + +Example: +.nf +curl --ssl-auto-client-cert https://example.com +.fi + +Added in 7.77.0. See also \fI\-\-proxy\-ssl\-auto\-client\-cert\fP. +.IP "\-\-ssl\-no\-revoke" +(TLS) (Schannel) Disable certificate revocation checks. WARNING: this option loosens +the SSL security, and by using this flag you ask for exactly that. + +Providing --ssl-no-revoke multiple times has no extra effect. +Disable it again with \-\-no-ssl-no-revoke. + +Example: +.nf +curl --ssl-no-revoke https://example.com +.fi + +See also \fI\-\-crlfile\fP. +.IP "\-\-ssl\-reqd" +(FTP IMAP POP3 SMTP LDAP) Require SSL/TLS for the connection \- often referred to as STARTTLS or STLS +because of the involved commands. Terminates the connection if the transfer +cannot be upgraded to use SSL/TLS. + +This option is handled in LDAP (added in 7.81.0). It is fully supported by the +OpenLDAP backend and rejected by the generic ldap backend if explicit TLS is +required. + +This option is unnecessary if you use a URL scheme that in itself implies +immediate and implicit use of TLS, like for FTPS, IMAPS, POP3S, SMTPS and +LDAPS. Such a transfer always fails if the TLS handshake does not work. + +This option was formerly known as \fI\-\-ftp\-ssl\-reqd\fP. + +Providing --ssl-reqd multiple times has no extra effect. +Disable it again with \-\-no-ssl-reqd. + +Example: +.nf +curl --ssl-reqd ftp://example.com +.fi + +See also \fI\-\-ssl\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-ssl\-revoke\-best\-effort" +(TLS) (Schannel) Ignore certificate revocation checks when they failed due to +missing/offline distribution points for the revocation check lists. + +Providing --ssl-revoke-best-effort multiple times has no extra effect. +Disable it again with \-\-no-ssl-revoke-best-effort. + +Example: +.nf +curl --ssl-revoke-best-effort https://example.com +.fi + +Added in 7.70.0. See also \fI\-\-crlfile\fP and \fI-k, \-\-insecure\fP. +.IP "\-\-ssl\-sessions " +(TLS) Use the given file to load SSL session tickets into curl\(aqs cache before +starting any transfers. At the end of a successful curl run, the cached +SSL sessions tickets are saved to the file, replacing any previous content. + +The file does not have to exist, but curl reports an error if it is +unable to create it. Unused loaded tickets are saved again, unless they +get replaced or purged from the cache for space reasons. + +Using a session file allows "\fI\-\-tls\-earlydata\fP" to send the first request +in "0\-RTT" mode, should an SSL session with the feature be found. Note that +a server may not support early data. Also note that early data does +not provide forward secrecy, e.g. is not as secure. + +The SSL session tickets are stored as base64 encoded text, each ticket on +its own line. The hostnames are cryptographically salted and hashed. While +this prevents someone from easily seeing the hosts you contacted, they could +still check if a specific hostname matches one of the values. + +This feature requires that the underlying libcurl was built with the +experimental SSL session import/export feature (SSLS\-EXPORT) enabled. + +If --ssl-sessions is provided several times, the last set value is used. + +Example: +.nf +curl --ssl-sessions sessions.txt https://example.com +.fi + +Added in 8.12.0. See also \fI\-\-tls\-earlydata\fP. +.IP "\-2, \-\-sslv2" +(SSL) This option previously asked curl to use SSLv2, but is now ignored +(added in 7.77.0). SSLv2 is widely considered insecure (see RFC 6176). + +Providing --sslv2 multiple times has no extra effect. + +Example: +.nf +curl --sslv2 https://example.com +.fi + +\fI-2, \-\-sslv2\fP requires that libcurl is built to support TLS. +This option is mutually exclusive with \fI-3, \-\-sslv3\fP, \fI-1, \-\-tlsv1\fP, \fI\-\-tlsv1.1\fP and \fI\-\-tlsv1.2\fP. +See also \fI\-\-http1.1\fP and \fI\-\-http2\fP. +.IP "\-3, \-\-sslv3" +(SSL) This option previously asked curl to use SSLv3, but is now ignored +(added in 7.77.0). SSLv3 is widely considered insecure (see RFC 7568). + +Providing --sslv3 multiple times has no extra effect. + +Example: +.nf +curl --sslv3 https://example.com +.fi + +\fI-3, \-\-sslv3\fP requires that libcurl is built to support TLS. +This option is mutually exclusive with \fI-2, \-\-sslv2\fP, \fI-1, \-\-tlsv1\fP, \fI\-\-tlsv1.1\fP and \fI\-\-tlsv1.2\fP. +See also \fI\-\-http1.1\fP and \fI\-\-http2\fP. +.IP "\-\-stderr " +Redirect all writes to stderr to the specified file instead. If the filename +is a plain \(aq\-\(aq, it is instead written to stdout. + +This option is global and does not need to be specified for each use of --next. + +If --stderr is provided several times, the last set value is used. + +Example: +.nf +curl --stderr output.txt https://example.com +.fi + +See also \fI-v, \-\-verbose\fP and \fI-s, \-\-silent\fP. +.IP "\-\-styled\-output" +Enable automatic use of bold font styles when writing HTTP headers to the +terminal. Use \fI\-\-no\-styled\-output\fP to switch them off. + +Styled output requires a terminal that supports bold fonts. This feature is +not present on curl for Windows due to lack of this capability. + +This option is global and does not need to be specified for each use of --next. + +Providing --styled-output multiple times has no extra effect. +Disable it again with \-\-no-styled-output. + +Example: +.nf +curl --styled-output -I https://example.com +.fi + +Added in 7.61.0. See also \fI-I, \-\-head\fP and \fI-v, \-\-verbose\fP. +.IP "\-\-suppress\-connect\-headers" +When \fI\-p, \-\-proxytunnel\fP is used and a CONNECT request is made, do not output proxy +CONNECT response headers. This option is meant to be used with \fI\-D, \-\-dump\-header\fP +or \fI\-i, \-\-show\-headers\fP which are used to show protocol headers in the output. It +has no effect on debug options such as \fI\-v, \-\-verbose\fP or \fI\-\-trace\fP, or any +statistics. + +Providing --suppress-connect-headers multiple times has no extra effect. +Disable it again with \-\-no-suppress-connect-headers. + +Example: +.nf +curl --suppress-connect-headers --show-headers -x proxy https://example.com +.fi + +See also \fI-D, \-\-dump\-header\fP, \fI-i, \-\-show\-headers\fP and \fI-p, \-\-proxytunnel\fP. +.IP "\-\-tcp\-fastopen" +Enable use of TCP Fast Open (RFC 7413). TCP Fast Open is a TCP extension that +allows data to be sent earlier over the connection (before the final +handshake ACK) if the client and server have been connected previously. + +Providing --tcp-fastopen multiple times has no extra effect. +Disable it again with \-\-no-tcp-fastopen. + +Example: +.nf +curl --tcp-fastopen https://example.com +.fi + +See also \fI\-\-false\-start\fP. +.IP "\-\-tcp\-nodelay" +Turn on the TCP_NODELAY option. See the \fIcurl_easy_setopt(3)\fP man page for +details about this option. + +curl sets this option by default and you need to explicitly switch it off if +you do not want it on. + +Providing --tcp-nodelay multiple times has no extra effect. +Disable it again with \-\-no-tcp-nodelay. + +Example: +.nf +curl --tcp-nodelay https://example.com +.fi + +See also \fI-N, \-\-no\-buffer\fP. +.IP "\-t, \-\-telnet\-option " +Pass options to the telnet protocol. Supported options are: +.RS +.IP TTYPE= +Sets the terminal type. +.IP "XDISPLOC=" +Sets the X display location. +.IP NEW_ENV= +Sets an environment variable. +.RE +.IP + +--telnet-option can be used several times in a command line + +Example: +.nf +curl -t TTYPE=vt100 telnet://example.com/ +.fi + +See also \fI-K, \-\-config\fP. +.IP "\-\-tftp\-blksize " +(TFTP) Set the TFTP \fBBLKSIZE\fP option (must be 512 or larger). This is the block +size that curl tries to use when transferring data to or from a TFTP +server. By default 512 bytes are used. + +If --tftp-blksize is provided several times, the last set value is used. + +Example: +.nf +curl --tftp-blksize 1024 tftp://example.com/file +.fi + +See also \fI\-\-tftp\-no\-options\fP. +.IP "\-\-tftp\-no\-options" +(TFTP) Do not send TFTP options requests. This improves interop with some legacy +servers that do not acknowledge or properly implement TFTP options. When this +option is used \fI\-\-tftp\-blksize\fP is ignored. + +Providing --tftp-no-options multiple times has no extra effect. +Disable it again with \-\-no-tftp-no-options. + +Example: +.nf +curl --tftp-no-options tftp://192.168.0.1/ +.fi + +See also \fI\-\-tftp\-blksize\fP. +.IP "\-z, \-\-time\-cond