Using Json string in the Http Header

Question

Recently I run into some weird issue with http header usage ( Adding multiple custom http request headers mystery) To avoid the problem at that time, I have put the fields into json string and add that json string into header instead of adding those fields into separate http headers.

For example, instead of

request.addHeader("UserName", mUserName); request.addHeader("AuthToken", mAuthorizationToken); request.addHeader("clientId","android_client"); 

I have created a json string and add it to the single header

String jsonStr="{\"UserName\":\"myname\",\"AuthToken\":\"123456\",\"clientId\":\"android_client\"}"; request.addHeader("JSonStr",jsonStr); 

Since I am new to writing Rest and dealing with the Http stuff, I don't know if my usage is proper or not. I would appreciate some insight into this.

Some links

http://lists.w3.org/Archives/Public/ietf-http-wg/2011OctDec/0133.html

Answer 1

Yes, you may use JSON in HTTP headers, given some limitations.

According to the HTTP spec, you MUST ensure that your header field-body contains only visible ASCII characters, tab, or space, and must not contain CR or LF characters (i.e. new lines, except via obsolete "folding whitespace").

Since many JSON encoders (e.g. json_encode in PHP) will encode both CR and LF characters as "\r" and "\n", and encode invisible or non-ASCII characters (e.g. "é" becomes "\u00e9"), you often don't need to worry about this.

Check the docs for your particular encoder or test it, though, because JSON strings technically allow most any Unicode character. For example, JSON.stringify() does not escape multibyte Unicode, by default. However, you can easily modify it to do so, e.g.

var charsToEncode = /[\u007f-\uffff]/g; function http_header_safe_json(v) {   return JSON.stringify(v).replace(charsToEncode,     function(c) {       return '\\u'+('000'+c.charCodeAt(0).toString(16)).slice(-4);     }   ); } 

Source

Alternatively, you can do as @rocketspacer suggested and base64-encode the JSON before inserting it into the header field (e.g. how JWT does it). This makes the JSON unreadable (by humans) in the header, but ensures that it will conform to the spec.

---

Worth noting, the original ARPA spec (RFC 822) has a special description of this exact use case, and the spirit of this echoes in later specs such as RFC 7230:

Certain field-bodies of headers may be interpreted according to an internal syntax that some systems may wish to parse.

Also, RFC 822 and RFC 7230 explicitly give no length constraints:

HTTP does not place a predefined limit on the length of each header field or on the length of the header section as a whole, as described in Section 2.5.

Answer 2

Base64encode it before sending. Just like how JSON Web Token do it.
Here's a NodeJs Example:

const myJsonStr = JSON.stringify(myData); const headerFriendlyStr = Buffer.from(myJsonStr, 'utf8').toString('base64'); res.addHeader('foo', headerFriendlyStr); 

Decode it when you need reading:

const myBase64Str = req.headers['foo']; const myJsonStr = Buffer.from(myBase64Str, 'base64').toString('utf8'); const myData = JSON.parse(myJsonStr);