xref: /aosp_15_r20/external/cronet/net/http/http_auth_challenge_tokenizer.h (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1 // Copyright 2014 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef NET_HTTP_HTTP_AUTH_CHALLENGE_TOKENIZER_H_
6 #define NET_HTTP_HTTP_AUTH_CHALLENGE_TOKENIZER_H_
7 
8 #include <string>
9 
10 #include "base/strings/string_piece.h"
11 #include "net/base/net_export.h"
12 #include "net/http/http_util.h"
13 
14 namespace net {
15 
16 // Breaks up a challenge string into the the auth scheme and parameter list,
17 // according to RFC 2617 Sec 1.2:
18 //     challenge = auth-scheme 1*SP 1#auth-param
19 //
20 // Depending on the challenge scheme, it may be appropriate to interpret the
21 // parameters as either a base-64 encoded string or a comma-delimited list
22 // of name-value pairs. param_pairs() and base64_param() methods are provided
23 // to support either usage.
24 class NET_EXPORT_PRIVATE HttpAuthChallengeTokenizer {
25  public:
26   HttpAuthChallengeTokenizer(std::string::const_iterator begin,
27                              std::string::const_iterator end);
28   ~HttpAuthChallengeTokenizer();
29 
30   // Get the original text.
challenge_text()31   std::string challenge_text() const {
32     return std::string(begin_, end_);
33   }
34 
35   // Get the authenthication scheme of the challenge. The returned scheme is
36   // always lowercase.
auth_scheme()37   const std::string& auth_scheme() const { return lower_case_scheme_; }
38 
params_begin()39   std::string::const_iterator params_begin() const { return params_begin_; }
params_end()40   std::string::const_iterator params_end() const { return params_end_; }
41   HttpUtil::NameValuePairsIterator param_pairs() const;
42   std::string base64_param() const;
43 
44  private:
45   void Init(std::string::const_iterator begin,
46             std::string::const_iterator end);
47 
48   std::string::const_iterator begin_;
49   std::string::const_iterator end_;
50 
51   std::string::const_iterator params_begin_;
52   std::string::const_iterator params_end_;
53 
54   std::string lower_case_scheme_;
55 };
56 
57 }  // namespace net
58 
59 #endif  // NET_HTTP_HTTP_AUTH_CHALLENGE_TOKENIZER_H_
60