esp-idf/components/esp_http_client/lib/include/http_auth.h

// Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at

//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


#ifndef _HTTP_BASIC_AUTH_H_
#define _HTTP_BASIC_AUTH_H_

/**
 * HTTP Digest authentication data
 */
typedef struct {
    char *method;       /*!< Request method, example: GET */
    char *algorithm;    /*!< Authentication algorithm */
    char *uri;          /*!< URI of request example: /path/to/file.html */
    char *realm;        /*!< Authentication realm */
    char *nonce;        /*!< Authentication nonce */
    char *qop;          /*!< Authentication qop */
    char *opaque;       /*!< Authentication opaque */
    uint64_t cnonce;    /*!< Authentication cnonce */
    int nc;             /*!< Authentication nc */
} esp_http_auth_data_t;

/**
 * @brief      This use for Http digest authentication method, create http header for digest authentication.
 *             The returned string need to free after use
 *
 * @param[in]  username   The username
 * @param[in]  password   The password
 * @param      auth_data  The auth data
 *
 * @return
 *     - HTTP Header value of Authorization, valid for digest authentication, must be freed after usage
 *     - NULL
 */
char *http_auth_digest(const char *username, const char *password, esp_http_auth_data_t *auth_data);

/**
 * @brief      This use for Http basic authentication method, create header value for basic http authentication
 *            The returned string need to free after use
 *
 * @param[in]  username  The username
 * @param[in]  password  The password
 *
 * @return
 *     - HTTP Header value of Authorization, valid for basic authentication, must be free after use
 *     - NULL
 */
char *http_auth_basic(const char *username, const char *password);
#endif