restclient-cpp icon indicating copy to clipboard operation
restclient-cpp copied to clipboard

headers field should be case insensitive

Open KaiPetzke opened this issue 5 years ago • 6 comments

Expected behaviour

The following code snippet:

    RestClient::Connection* conn = new RestClient::Connection("https://httpbin.org");
    RestClient::Response& r = conn->get("/get");
    for(auto& name : { "date", "Date" }) {
        try {
            std::string& value = r.headers.at(name);
            std::cout << name << ": \"" << value << "\"" << std::endl;
        } catch(std::out_of_range& oor) {
            std::cout << name << ": not found" << std::endl;
        }
    }

should yield a result similiar to the following:

date: "Tue, 11 Aug 2020 19:52:17 GMT" Date: "Tue, 11 Aug 2020 19:52:17 GMT"

Actual behaviour

The result is as follows:

date: not found Date: "Tue, 11 Aug 2020 19:52:17 GMT"

This is an error, as according to RFC 2616: "Field names are case-insensitive". And yes, unfortunately, there are servers, that change the case of their response header fields at will.

Environment and debugging details

This happens with any C compiler and libcurl

Suggested fix:

Use a custom compare function to make the std::map in RestClient::HeaderFields case-insensitive. I have attached a file with the suggested change. Yes, it uses std::tolower(), which unfortunately is locale dependant, for conversion to lowercase. So depending on language settings, tolower() might convert, say, Ç to ç or not. If that is considered an issue, an alternative would be to explicitely only map characters in the range 'A' to 'Z' to 'a' to 'z', and use this mapping function instead of std::tolower():

    unsigned char ascii_tolower(const unsigned char c) {
        return (c >= 'A' && c <= 'Z') ? ((c - 'A') + 'a') : c;
    }

restclient.diff.txt

KaiPetzke avatar Aug 11 '20 20:08 KaiPetzke

@KaiPetzke if you can please submit a fix for this it would be appreciated. It sounds like you already have it but are just unfamiliar with the contributing guidelines?

edwinpjacques avatar Oct 30 '20 17:10 edwinpjacques

Yeah, I didn't read the contribution guidelines. I am busy this week, will try to add a formal fix next week.

@edwinpjacques What do you suggest about my comments below the headline "suggested fix"? Do you prefer std::tolower() or the locale independant ascii_tolower()?

KaiPetzke avatar Nov 02 '20 10:11 KaiPetzke

std::tolower looks good. https://en.cppreference.com/w/cpp/string/byte/tolower

edwinpjacques avatar Nov 03 '20 20:11 edwinpjacques

I am still busy, will look at all these issues early next year.

KaiPetzke avatar Dec 09 '20 14:12 KaiPetzke

Shall I fix the issue?

Mirza585 avatar Jun 17 '21 10:06 Mirza585