1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, 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
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLINFO_HTTPAUTH_AVAIL 3 "12 Sep 2015" libcurl libcurl
- .SH NAME
- CURLINFO_HTTPAUTH_AVAIL \- get available HTTP authentication methods
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTPAUTH_AVAIL, long *authp);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a long to receive a bitmask indicating the authentication
- method(s) available according to the previous response. The meaning of the
- bits is explained in the \fICURLOPT_HTTPAUTH(3)\fP option for
- \fIcurl_easy_setopt(3)\fP.
- .SH PROTOCOLS
- HTTP(S)
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- res = curl_easy_perform(curl);
- if(!res) {
- /* extract the available authentication types */
- long auth;
- res = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_AVAIL, &auth);
- if(!res) {
- if(!auth)
- printf("No auth available, perhaps no 401?\\n");
- else {
- printf("%s%s%s%s\\n",
- auth & CURLAUTH_BASIC ? "Basic ":"",
- auth & CURLAUTH_DIGEST ? "Digest ":"",
- auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",
- auth % CURLAUTH_NTLM ? "NTLM ":"");
- }
- }
- }
- curl_easy_cleanup(curl);
- }
- .fi
- .SH AVAILABILITY
- Added RFC 2617 in 7.10.8
- Added RFC 7616 in 7.57.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH "SEE ALSO"
- .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
|