xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_KRBLEVEL.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_KRBLEVEL
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_KRBLEVEL (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_USE_SSL (3)
10*6236dae4SAndroid Build Coastguard WorkerProtocol:
11*6236dae4SAndroid Build Coastguard Worker  - FTP
12*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.16.4
13*6236dae4SAndroid Build Coastguard Worker---
14*6236dae4SAndroid Build Coastguard Worker
15*6236dae4SAndroid Build Coastguard Worker# NAME
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard WorkerCURLOPT_KRBLEVEL - FTP kerberos security level
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker~~~c
22*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_KRBLEVEL, char *level);
25*6236dae4SAndroid Build Coastguard Worker~~~
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard WorkerPass a char pointer as parameter. Set the kerberos security level for FTP;
30*6236dae4SAndroid Build Coastguard Workerthis also enables kerberos awareness. This is a string that should match one
31*6236dae4SAndroid Build Coastguard Workerof the following: &'clear', &'safe', &'confidential' or &'private'. If the
32*6236dae4SAndroid Build Coastguard Workerstring is set but does not match one of these, 'private' is used. Set the
33*6236dae4SAndroid Build Coastguard Workerstring to NULL to disable kerberos support for FTP.
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard WorkerThe application does not have to keep the string around after setting this
36*6236dae4SAndroid Build Coastguard Workeroption.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard WorkerThe application does not have to keep the string around after setting this
39*6236dae4SAndroid Build Coastguard Workeroption.
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard Worker# DEFAULT
42*6236dae4SAndroid Build Coastguard Worker
43*6236dae4SAndroid Build Coastguard WorkerNULL
44*6236dae4SAndroid Build Coastguard Worker
45*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
48*6236dae4SAndroid Build Coastguard Worker
49*6236dae4SAndroid Build Coastguard Worker~~~c
50*6236dae4SAndroid Build Coastguard Workerint main(void)
51*6236dae4SAndroid Build Coastguard Worker{
52*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
53*6236dae4SAndroid Build Coastguard Worker  if(curl) {
54*6236dae4SAndroid Build Coastguard Worker    CURLcode res;
55*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
56*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_KRBLEVEL, "private");
57*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
58*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
59*6236dae4SAndroid Build Coastguard Worker  }
60*6236dae4SAndroid Build Coastguard Worker}
61*6236dae4SAndroid Build Coastguard Worker~~~
62*6236dae4SAndroid Build Coastguard Worker
63*6236dae4SAndroid Build Coastguard Worker# HISTORY
64*6236dae4SAndroid Build Coastguard Worker
65*6236dae4SAndroid Build Coastguard WorkerThis option was known as CURLOPT_KRB4LEVEL up to 7.16.3
66*6236dae4SAndroid Build Coastguard Worker
67*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
68*6236dae4SAndroid Build Coastguard Worker
69*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
72*6236dae4SAndroid Build Coastguard WorkerCURLE_OUT_OF_MEMORY if there was insufficient heap space.
73