CURLOPT_KRBLEVEL.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_KRBLEVEL 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_KRBLEVEL \- FTP kerberos security level
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KRBLEVEL, char *level);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a char * as parameter. Set the kerberos security level for FTP; this also
  35. enables kerberos awareness. This is a string that should match one of the
  36. following: \&'clear', \&'safe', \&'confidential' or \&'private'. If the
  37. string is set but does not match one of these, 'private' will be used. Set the
  38. string to NULL to disable kerberos support for FTP.
  39. The application does not have to keep the string around after setting this
  40. option.
  41. .SH DEFAULT
  42. NULL
  43. .SH PROTOCOLS
  44. FTP
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/foo.bin");
  50. curl_easy_setopt(curl, CURLOPT_KRBLEVEL, "private");
  51. ret = curl_easy_perform(curl);
  52. curl_easy_cleanup(curl);
  53. }
  54. .fi
  55. .SH AVAILABILITY
  56. This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
  57. .SH RETURN VALUE
  58. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  59. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  60. .SH "SEE ALSO"
  61. .BR CURLOPT_KRBLEVEL "(3), " CURLOPT_USE_SSL "(3), "