romenskiy2012/curl

mirror of https://github.com/curl/curl.git synced 2026-05-23 20:06:23 +03:00

Daniel Stenberg eefcc1bda4

docs: introduce "curldown" for libcurl man page format

curldown is this new file format for libcurl man pages. It is markdown
inspired with differences:

- Each file has a set of leading headers with meta-data
- Supports a small subset of markdown
- Uses .md file extensions for editors/IDE/GitHub to treat them nicely
- Generates man pages very similar to the previous ones
- Generates man pages that still convert nicely to HTML on the website
- Detects and highlights mentions of curl symbols automatically (when
  their man page section is specified)

tools:

- cd2nroff: converts from curldown to nroff man page
- nroff2cd: convert an (old) nroff man page to curldown
- cdall: convert many nroff pages to curldown versions
- cd2cd: verifies and updates a curldown to latest curldown

This setup generates .3 versions of all the curldown versions at build time.

CI:

Since the documentation is now technically markdown in the eyes of many
things, the CI runs many more tests and checks on this documentation,
including proselint, link checkers and tests that make sure we capitalize the
first letter after a period...

Closes #12730

2024-01-23 00:29:02 +01:00

2.4 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

curl

CURLOPT_SSL_CIPHER_LIST

libcurl

CURLOPT_PROXY_SSL_CIPHER_LIST (3)

CURLOPT_PROXY_TLS13_CIPHERS (3)

CURLOPT_SSLVERSION (3)

CURLOPT_TLS13_CIPHERS (3)

CURLOPT_USE_SSL (3)

NAME

CURLOPT_SSL_CIPHER_LIST - ciphers to use for TLS

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CIPHER_LIST, char *list);

DESCRIPTION

Pass a char pointer, pointing to a null-terminated string holding the list of ciphers to use for the SSL connection. The list must be syntactically correct, it consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators but colons are normally used, &!, &- and &+ can be used as operators.

For OpenSSL and GnuTLS valid examples of cipher lists include RC4-SHA, SHA1+DES, TLSv1 and DEFAULT. The default list is normally set when you compile OpenSSL.

For WolfSSL, valid examples of cipher lists include ECDHE-RSA-RC4-SHA, AES256-SHA:AES256-SHA256, etc.

For BearSSL, valid examples of cipher lists include ECDHE-RSA-CHACHA20-POLY1305:ECDHE-RSA-AES128-GCM-SHA256, or when using IANA names TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256:TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, etc. With BearSSL you do not add/remove ciphers. If one uses this option then all known ciphers are disabled and only those passed in are enabled.

For Schannel, you can use this option to set algorithms but not specific cipher suites. Refer to the ciphers lists document for algorithms.

Find more details about cipher lists on this URL:

https://curl.se/docs/ssl-ciphers.html

The application does not have to keep the string around after setting this option.

DEFAULT

NULL, use internal default

PROTOCOLS

All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_SSL_CIPHER_LIST, "TLSv1");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in 7.9, in 7.83.0 for BearSSL

If built TLS enabled.

RETURN VALUE

Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.

2.4 KiB Raw Blame History