author | Michael Krelin <hacker@klever.net> | 2008-01-30 00:01:32 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2008-01-30 00:01:32 (UTC) |
commit | 66b14d4368d661daf2248e36ac4f9a3f69f6a75a (patch) (unidiff) | |
tree | 01bfef4ebeb4cd52f628a598a709a8adde971305 /include | |
parent | dc5dad0709ae8dd0a4be74248a22a78e47ba90e2 (diff) | |
download | libopkele-66b14d4368d661daf2248e36ac4f9a3f69f6a75a.zip libopkele-66b14d4368d661daf2248e36ac4f9a3f69f6a75a.tar.gz libopkele-66b14d4368d661daf2248e36ac4f9a3f69f6a75a.tar.bz2 |
a few changes to the infrastructure
* added mode_unknown to the mode_t enumeration
* add to_keyvalues(ostream&) to openid message class
* fixed openid_message_t::set_field for the case of overwriting
Signed-off-by: Michael Krelin <hacker@klever.net>
-rw-r--r-- | include/opkele/types.h | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/include/opkele/types.h b/include/opkele/types.h index d5ad258..842a722 100644 --- a/include/opkele/types.h +++ b/include/opkele/types.h | |||
@@ -1,207 +1,209 @@ | |||
1 | #ifndef __OPKELE_TYPES_H | 1 | #ifndef __OPKELE_TYPES_H |
2 | #define __OPKELE_TYPES_H | 2 | #define __OPKELE_TYPES_H |
3 | 3 | ||
4 | /** | 4 | /** |
5 | * @file | 5 | * @file |
6 | * @brief various types declarations | 6 | * @brief various types declarations |
7 | */ | 7 | */ |
8 | 8 | ||
9 | #include <ostream> | 9 | #include <ostream> |
10 | #include <vector> | 10 | #include <vector> |
11 | #include <string> | 11 | #include <string> |
12 | #include <map> | 12 | #include <map> |
13 | #include <set> | 13 | #include <set> |
14 | #include <list> | 14 | #include <list> |
15 | #include <opkele/iterator.h> | 15 | #include <opkele/iterator.h> |
16 | #include <opkele/tr1-mem.h> | 16 | #include <opkele/tr1-mem.h> |
17 | 17 | ||
18 | namespace opkele { | 18 | namespace opkele { |
19 | using std::vector; | 19 | using std::vector; |
20 | using std::string; | 20 | using std::string; |
21 | using std::map; | 21 | using std::map; |
22 | using std::ostream; | 22 | using std::ostream; |
23 | using std::multimap; | 23 | using std::multimap; |
24 | using std::set; | 24 | using std::set; |
25 | using std::list; | 25 | using std::list; |
26 | using std::iterator; | 26 | using std::iterator; |
27 | using std::forward_iterator_tag; | 27 | using std::forward_iterator_tag; |
28 | 28 | ||
29 | /** | 29 | /** |
30 | * the OpenID operation mode | 30 | * the OpenID operation mode |
31 | */ | 31 | */ |
32 | typedef enum _mode_t { | 32 | typedef enum _mode_t { |
33 | mode_unknown = 0, | ||
33 | mode_associate, | 34 | mode_associate, |
34 | mode_checkid_immediate, | 35 | mode_checkid_immediate, |
35 | mode_checkid_setup, | 36 | mode_checkid_setup, |
36 | mode_check_association | 37 | mode_check_association |
37 | } mode_t; | 38 | } mode_t; |
38 | 39 | ||
39 | /** | 40 | /** |
40 | * the association secret container | 41 | * the association secret container |
41 | */ | 42 | */ |
42 | class secret_t : public vector<unsigned char> { | 43 | class secret_t : public vector<unsigned char> { |
43 | public: | 44 | public: |
44 | 45 | ||
45 | /** | 46 | /** |
46 | * xor the secret and hmac together and encode, using base64 | 47 | * xor the secret and hmac together and encode, using base64 |
47 | * @param key_d pointer to the message digest | 48 | * @param key_d pointer to the message digest |
48 | * @param rv reference to the return value | 49 | * @param rv reference to the return value |
49 | */ | 50 | */ |
50 | void enxor_to_base64(const unsigned char *key_d,string& rv) const; | 51 | void enxor_to_base64(const unsigned char *key_d,string& rv) const; |
51 | /** | 52 | /** |
52 | * decode base64-encoded secret and xor it with the message digest | 53 | * decode base64-encoded secret and xor it with the message digest |
53 | * @param key_d pointer to the message digest | 54 | * @param key_d pointer to the message digest |
54 | * @param b64 base64-encoded secret value | 55 | * @param b64 base64-encoded secret value |
55 | */ | 56 | */ |
56 | void enxor_from_base64(const unsigned char *key_d,const string& b64); | 57 | void enxor_from_base64(const unsigned char *key_d,const string& b64); |
57 | /** | 58 | /** |
58 | * plainly encode to base64 representation | 59 | * plainly encode to base64 representation |
59 | * @param rv reference to the return value | 60 | * @param rv reference to the return value |
60 | */ | 61 | */ |
61 | void to_base64(string& rv) const; | 62 | void to_base64(string& rv) const; |
62 | /** | 63 | /** |
63 | * decode cleartext secret from base64 | 64 | * decode cleartext secret from base64 |
64 | * @param b64 base64-encoded representation of the secret value | 65 | * @param b64 base64-encoded representation of the secret value |
65 | */ | 66 | */ |
66 | void from_base64(const string& b64); | 67 | void from_base64(const string& b64); |
67 | }; | 68 | }; |
68 | 69 | ||
69 | /** | 70 | /** |
70 | * Interface to the association. | 71 | * Interface to the association. |
71 | */ | 72 | */ |
72 | class association_t { | 73 | class association_t { |
73 | public: | 74 | public: |
74 | 75 | ||
75 | virtual ~association_t() { } | 76 | virtual ~association_t() { } |
76 | 77 | ||
77 | /** | 78 | /** |
78 | * retrieve the server with which association was established. | 79 | * retrieve the server with which association was established. |
79 | * @return server name | 80 | * @return server name |
80 | */ | 81 | */ |
81 | virtual string server() const = 0; | 82 | virtual string server() const = 0; |
82 | /** | 83 | /** |
83 | * retrieve the association handle. | 84 | * retrieve the association handle. |
84 | * @return handle | 85 | * @return handle |
85 | */ | 86 | */ |
86 | virtual string handle() const = 0; | 87 | virtual string handle() const = 0; |
87 | /** | 88 | /** |
88 | * retrieve the association type. | 89 | * retrieve the association type. |
89 | * @return association type | 90 | * @return association type |
90 | */ | 91 | */ |
91 | virtual string assoc_type() const = 0; | 92 | virtual string assoc_type() const = 0; |
92 | /** | 93 | /** |
93 | * retrieve the association secret. | 94 | * retrieve the association secret. |
94 | * @return association secret | 95 | * @return association secret |
95 | */ | 96 | */ |
96 | virtual secret_t secret() const = 0; | 97 | virtual secret_t secret() const = 0; |
97 | /** | 98 | /** |
98 | * retrieve the number of seconds the association expires in. | 99 | * retrieve the number of seconds the association expires in. |
99 | * @return seconds till expiration | 100 | * @return seconds till expiration |
100 | */ | 101 | */ |
101 | virtual int expires_in() const = 0; | 102 | virtual int expires_in() const = 0; |
102 | /** | 103 | /** |
103 | * check whether the association is stateless. | 104 | * check whether the association is stateless. |
104 | * @return true if stateless | 105 | * @return true if stateless |
105 | */ | 106 | */ |
106 | virtual bool stateless() const = 0; | 107 | virtual bool stateless() const = 0; |
107 | /** | 108 | /** |
108 | * check whether the association is expired. | 109 | * check whether the association is expired. |
109 | * @return true if expired | 110 | * @return true if expired |
110 | */ | 111 | */ |
111 | virtual bool is_expired() const = 0; | 112 | virtual bool is_expired() const = 0; |
112 | }; | 113 | }; |
113 | 114 | ||
114 | /** | 115 | /** |
115 | * the shared_ptr<> for association_t object type | 116 | * the shared_ptr<> for association_t object type |
116 | */ | 117 | */ |
117 | typedef tr1mem::shared_ptr<association_t> assoc_t; | 118 | typedef tr1mem::shared_ptr<association_t> assoc_t; |
118 | 119 | ||
119 | class basic_openid_message { | 120 | class basic_openid_message { |
120 | public: | 121 | public: |
121 | typedef list<string> fields_t; | 122 | typedef list<string> fields_t; |
122 | typedef util::forward_iterator_proxy< | 123 | typedef util::forward_iterator_proxy< |
123 | string,const string&,const string* | 124 | string,const string&,const string* |
124 | > fields_iterator; | 125 | > fields_iterator; |
125 | 126 | ||
126 | basic_openid_message() { } | 127 | basic_openid_message() { } |
127 | basic_openid_message(const basic_openid_message& x); | 128 | basic_openid_message(const basic_openid_message& x); |
128 | void copy_to(basic_openid_message& x) const; | 129 | void copy_to(basic_openid_message& x) const; |
129 | 130 | ||
130 | virtual bool has_field(const string& n) const = 0; | 131 | virtual bool has_field(const string& n) const = 0; |
131 | virtual const string& get_field(const string& n) const = 0; | 132 | virtual const string& get_field(const string& n) const = 0; |
132 | 133 | ||
133 | virtual bool has_ns(const string& uri) const; | 134 | virtual bool has_ns(const string& uri) const; |
134 | virtual string get_ns(const string& uri) const; | 135 | virtual string get_ns(const string& uri) const; |
135 | 136 | ||
136 | virtual fields_iterator fields_begin() const = 0; | 137 | virtual fields_iterator fields_begin() const = 0; |
137 | virtual fields_iterator fields_end() const = 0; | 138 | virtual fields_iterator fields_end() const = 0; |
138 | 139 | ||
139 | virtual string append_query(const string& url) const; | 140 | virtual string append_query(const string& url) const; |
140 | virtual string query_string() const; | 141 | virtual string query_string() const; |
141 | 142 | ||
142 | 143 | ||
143 | virtual void reset_fields(); | 144 | virtual void reset_fields(); |
144 | virtual void set_field(const string& n,const string& v); | 145 | virtual void set_field(const string& n,const string& v); |
145 | virtual void reset_field(const string& n); | 146 | virtual void reset_field(const string& n); |
146 | 147 | ||
147 | virtual void from_keyvalues(const string& kv); | 148 | virtual void from_keyvalues(const string& kv); |
149 | virtual void to_keyvalues(ostream& o) const; | ||
148 | 150 | ||
149 | void add_to_signed(const string& fields); | 151 | void add_to_signed(const string& fields); |
150 | string find_ns(const string& uri,const char *pfx) const; | 152 | string find_ns(const string& uri,const char *pfx) const; |
151 | string allocate_ns(const string& uri,const char *pfx); | 153 | string allocate_ns(const string& uri,const char *pfx); |
152 | }; | 154 | }; |
153 | 155 | ||
154 | class openid_message_t : public basic_openid_message, public map<string,string> { | 156 | class openid_message_t : public basic_openid_message, public map<string,string> { |
155 | public: | 157 | public: |
156 | openid_message_t() { } | 158 | openid_message_t() { } |
157 | openid_message_t(const basic_openid_message& x) | 159 | openid_message_t(const basic_openid_message& x) |
158 | : basic_openid_message(x) { } | 160 | : basic_openid_message(x) { } |
159 | 161 | ||
160 | void copy_to(basic_openid_message& x) const; | 162 | void copy_to(basic_openid_message& x) const; |
161 | 163 | ||
162 | bool has_field(const string& n) const; | 164 | bool has_field(const string& n) const; |
163 | const string& get_field(const string& n) const; | 165 | const string& get_field(const string& n) const; |
164 | virtual fields_iterator fields_begin() const; | 166 | virtual fields_iterator fields_begin() const; |
165 | virtual fields_iterator fields_end() const; | 167 | virtual fields_iterator fields_end() const; |
166 | 168 | ||
167 | void reset_fields(); | 169 | void reset_fields(); |
168 | void set_field(const string& n,const string& v); | 170 | void set_field(const string& n,const string& v); |
169 | void reset_field(const string& n); | 171 | void reset_field(const string& n); |
170 | }; | 172 | }; |
171 | 173 | ||
172 | /** | 174 | /** |
173 | * request/response parameters map | 175 | * request/response parameters map |
174 | */ | 176 | */ |
175 | class params_t : public openid_message_t { | 177 | class params_t : public openid_message_t { |
176 | public: | 178 | public: |
177 | 179 | ||
178 | /** | 180 | /** |
179 | * check whether the parameter is present. | 181 | * check whether the parameter is present. |
180 | * @param n the parameter name | 182 | * @param n the parameter name |
181 | * @return true if yes | 183 | * @return true if yes |
182 | */ | 184 | */ |
183 | bool has_param(const string& n) const { | 185 | bool has_param(const string& n) const { |
184 | return has_field(n); } | 186 | return has_field(n); } |
185 | /** | 187 | /** |
186 | * retrieve the parameter (const version) | 188 | * retrieve the parameter (const version) |
187 | * @param n the parameter name | 189 | * @param n the parameter name |
188 | * @return the parameter value | 190 | * @return the parameter value |
189 | * @throw failed_lookup if there is no such parameter | 191 | * @throw failed_lookup if there is no such parameter |
190 | */ | 192 | */ |
191 | const string& get_param(const string& n) const { | 193 | const string& get_param(const string& n) const { |
192 | return get_field(n); } | 194 | return get_field(n); } |
193 | 195 | ||
194 | /** | 196 | /** |
195 | * parse the OpenID key/value data. | 197 | * parse the OpenID key/value data. |
196 | * @param kv the OpenID key/value data | 198 | * @param kv the OpenID key/value data |
197 | */ | 199 | */ |
198 | void parse_keyvalues(const string& kv) { | 200 | void parse_keyvalues(const string& kv) { |
199 | from_keyvalues(kv); } | 201 | from_keyvalues(kv); } |
200 | 202 | ||
201 | string append_query(const string& url,const char *prefix="openid.") const; | 203 | string append_query(const string& url,const char *prefix="openid.") const; |
202 | 204 | ||
203 | }; | 205 | }; |
204 | 206 | ||
205 | } | 207 | } |
206 | 208 | ||
207 | #endif /* __OPKELE_TYPES_H */ | 209 | #endif /* __OPKELE_TYPES_H */ |