summaryrefslogtreecommitdiffabout
path: root/include/opkele
authorMichael Krelin <hacker@klever.net>2008-03-03 17:16:32 (UTC)
committer Michael Krelin <hacker@klever.net>2008-03-03 17:16:32 (UTC)
commitecb6a585d1fc3705836dc896fe348b970101e8d3 (patch) (unidiff)
tree2ae11b4109988ab63093c041f8d5925794d51323 /include/opkele
parent374985b5317d559b561d7f557034661e314f5605 (diff)
downloadlibopkele-ecb6a585d1fc3705836dc896fe348b970101e8d3.zip
libopkele-ecb6a585d1fc3705836dc896fe348b970101e8d3.tar.gz
libopkele-ecb6a585d1fc3705836dc896fe348b970101e8d3.tar.bz2
renamed basic_message to basic_fields
since oauth fieldsets aren't really messages Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (limited to 'include/opkele') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/types.h22
1 files changed, 9 insertions, 13 deletions
diff --git a/include/opkele/types.h b/include/opkele/types.h
index bf50e2b..f63bf5d 100644
--- a/include/opkele/types.h
+++ b/include/opkele/types.h
@@ -25,223 +25,219 @@ namespace opkele {
25 using std::set; 25 using std::set;
26 using std::list; 26 using std::list;
27 using std::iterator; 27 using std::iterator;
28 using std::forward_iterator_tag; 28 using std::forward_iterator_tag;
29 29
30 /** 30 /**
31 * the OpenID operation mode 31 * the OpenID operation mode
32 */ 32 */
33 typedef enum _mode_t { 33 typedef enum _mode_t {
34 mode_unknown = 0, 34 mode_unknown = 0,
35 mode_associate, 35 mode_associate,
36 mode_checkid_immediate, 36 mode_checkid_immediate,
37 mode_checkid_setup, 37 mode_checkid_setup,
38 mode_check_association 38 mode_check_association
39 } mode_t; 39 } mode_t;
40 40
41 /** 41 /**
42 * the association secret container 42 * the association secret container
43 */ 43 */
44 class secret_t : public vector<unsigned char> { 44 class secret_t : public vector<unsigned char> {
45 public: 45 public:
46 46
47 /** 47 /**
48 * xor the secret and hmac together and encode, using base64 48 * xor the secret and hmac together and encode, using base64
49 * @param key_d pointer to the message digest 49 * @param key_d pointer to the message digest
50 * @param rv reference to the return value 50 * @param rv reference to the return value
51 */ 51 */
52 void enxor_to_base64(const unsigned char *key_d,string& rv) const; 52 void enxor_to_base64(const unsigned char *key_d,string& rv) const;
53 /** 53 /**
54 * decode base64-encoded secret and xor it with the message digest 54 * decode base64-encoded secret and xor it with the message digest
55 * @param key_d pointer to the message digest 55 * @param key_d pointer to the message digest
56 * @param b64 base64-encoded secret value 56 * @param b64 base64-encoded secret value
57 */ 57 */
58 void enxor_from_base64(const unsigned char *key_d,const string& b64); 58 void enxor_from_base64(const unsigned char *key_d,const string& b64);
59 /** 59 /**
60 * plainly encode to base64 representation 60 * plainly encode to base64 representation
61 * @param rv reference to the return value 61 * @param rv reference to the return value
62 */ 62 */
63 void to_base64(string& rv) const; 63 void to_base64(string& rv) const;
64 /** 64 /**
65 * decode cleartext secret from base64 65 * decode cleartext secret from base64
66 * @param b64 base64-encoded representation of the secret value 66 * @param b64 base64-encoded representation of the secret value
67 */ 67 */
68 void from_base64(const string& b64); 68 void from_base64(const string& b64);
69 }; 69 };
70 70
71 /** 71 /**
72 * Interface to the association. 72 * Interface to the association.
73 */ 73 */
74 class association_t { 74 class association_t {
75 public: 75 public:
76 76
77 virtual ~association_t() { } 77 virtual ~association_t() { }
78 78
79 /** 79 /**
80 * retrieve the server with which association was established. 80 * retrieve the server with which association was established.
81 * @return server name 81 * @return server name
82 */ 82 */
83 virtual string server() const = 0; 83 virtual string server() const = 0;
84 /** 84 /**
85 * retrieve the association handle. 85 * retrieve the association handle.
86 * @return handle 86 * @return handle
87 */ 87 */
88 virtual string handle() const = 0; 88 virtual string handle() const = 0;
89 /** 89 /**
90 * retrieve the association type. 90 * retrieve the association type.
91 * @return association type 91 * @return association type
92 */ 92 */
93 virtual string assoc_type() const = 0; 93 virtual string assoc_type() const = 0;
94 /** 94 /**
95 * retrieve the association secret. 95 * retrieve the association secret.
96 * @return association secret 96 * @return association secret
97 */ 97 */
98 virtual secret_t secret() const = 0; 98 virtual secret_t secret() const = 0;
99 /** 99 /**
100 * retrieve the number of seconds the association expires in. 100 * retrieve the number of seconds the association expires in.
101 * @return seconds till expiration 101 * @return seconds till expiration
102 */ 102 */
103 virtual int expires_in() const = 0; 103 virtual int expires_in() const = 0;
104 /** 104 /**
105 * check whether the association is stateless. 105 * check whether the association is stateless.
106 * @return true if stateless 106 * @return true if stateless
107 */ 107 */
108 virtual bool stateless() const = 0; 108 virtual bool stateless() const = 0;
109 /** 109 /**
110 * check whether the association is expired. 110 * check whether the association is expired.
111 * @return true if expired 111 * @return true if expired
112 */ 112 */
113 virtual bool is_expired() const = 0; 113 virtual bool is_expired() const = 0;
114 }; 114 };
115 115
116 /** 116 /**
117 * the shared_ptr<> for association_t object type 117 * the shared_ptr<> for association_t object type
118 */ 118 */
119 typedef tr1mem::shared_ptr<association_t> assoc_t; 119 typedef tr1mem::shared_ptr<association_t> assoc_t;
120 120
121 class basic_message { 121 class basic_fields {
122 public: 122 public:
123 typedef util::forward_iterator_proxy< 123 typedef util::forward_iterator_proxy<
124 string,const string&,const string* 124 string,const string&,const string*
125 > fields_iterator; 125 > fields_iterator;
126 126
127 basic_message() { } 127 basic_fields() { }
128 virtual ~basic_message() { } 128 virtual ~basic_fields() { }
129 basic_message(const basic_message& x); 129 basic_fields(const basic_fields& x);
130 void copy_to(basic_message& x) const; 130 void copy_to(basic_fields& x) const;
131 void append_to(basic_message& x) const; 131 void append_to(basic_fields& x) const;
132 132
133 virtual bool has_field(const string& n) const = 0; 133 virtual bool has_field(const string& n) const = 0;
134 virtual const string& get_field(const string& n) const = 0; 134 virtual const string& get_field(const string& n) const = 0;
135 135
136 virtual fields_iterator fields_begin() const = 0; 136 virtual fields_iterator fields_begin() const = 0;
137 virtual fields_iterator fields_end() const = 0; 137 virtual fields_iterator fields_end() const = 0;
138 138
139 virtual string append_query(const string& url,const char *pfx=0) const; 139 virtual string append_query(const string& url,const char *pfx=0) const;
140 virtual string query_string(const char *pfx=0) const; 140 virtual string query_string(const char *pfx=0) const;
141 141
142 virtual void reset_fields(); 142 virtual void reset_fields();
143 virtual void set_field(const string& n,const string& v); 143 virtual void set_field(const string& n,const string& v);
144 virtual void reset_field(const string& n); 144 virtual void reset_field(const string& n);
145 145
146 }; 146 };
147 147
148 class basic_openid_message : public basic_message { 148 class basic_openid_message : public basic_fields {
149 public: 149 public:
150 typedef list<string> fields_t;
151 typedef util::forward_iterator_proxy<
152 string,const string&,const string*
153 > fields_iterator;
154 150
155 basic_openid_message() { } 151 basic_openid_message() { }
156 basic_openid_message(const basic_openid_message& x); 152 basic_openid_message(const basic_openid_message& x);
157 153
158 virtual bool has_ns(const string& uri) const; 154 virtual bool has_ns(const string& uri) const;
159 virtual string get_ns(const string& uri) const; 155 virtual string get_ns(const string& uri) const;
160 156
161 virtual string append_query(const string& url,const char *pfx="openid.") const { 157 virtual string append_query(const string& url,const char *pfx="openid.") const {
162 return basic_message::append_query(url,pfx); } 158 return basic_fields::append_query(url,pfx); }
163 virtual string query_string(const char *pfx="openid.") const { 159 virtual string query_string(const char *pfx="openid.") const {
164 return basic_message::query_string(pfx); } 160 return basic_fields::query_string(pfx); }
165 161
166 virtual void from_keyvalues(const string& kv); 162 virtual void from_keyvalues(const string& kv);
167 virtual void to_keyvalues(ostream& o) const; 163 virtual void to_keyvalues(ostream& o) const;
168 164
169 virtual void to_htmlhiddens(ostream& o,const char* pfx=0) const; 165 virtual void to_htmlhiddens(ostream& o,const char* pfx=0) const;
170 166
171 void add_to_signed(const string& fields); 167 void add_to_signed(const string& fields);
172 string find_ns(const string& uri,const char *pfx) const; 168 string find_ns(const string& uri,const char *pfx) const;
173 string allocate_ns(const string& uri,const char *pfx); 169 string allocate_ns(const string& uri,const char *pfx);
174 }; 170 };
175 171
176 class openid_message_t : public basic_openid_message, public map<string,string> { 172 class openid_message_t : public basic_openid_message, public map<string,string> {
177 public: 173 public:
178 openid_message_t() { } 174 openid_message_t() { }
179 openid_message_t(const basic_openid_message& x) 175 openid_message_t(const basic_openid_message& x)
180 : basic_openid_message(x) { } 176 : basic_openid_message(x) { }
181 177
182 bool has_field(const string& n) const; 178 bool has_field(const string& n) const;
183 const string& get_field(const string& n) const; 179 const string& get_field(const string& n) const;
184 virtual fields_iterator fields_begin() const; 180 virtual fields_iterator fields_begin() const;
185 virtual fields_iterator fields_end() const; 181 virtual fields_iterator fields_end() const;
186 182
187 void reset_fields(); 183 void reset_fields();
188 void set_field(const string& n,const string& v); 184 void set_field(const string& n,const string& v);
189 void reset_field(const string& n); 185 void reset_field(const string& n);
190 }; 186 };
191 187
192 /** 188 /**
193 * request/response parameters map 189 * request/response parameters map
194 */ 190 */
195 class params_t : public openid_message_t { 191 class params_t : public openid_message_t {
196 public: 192 public:
197 193
198 /** 194 /**
199 * check whether the parameter is present. 195 * check whether the parameter is present.
200 * @param n the parameter name 196 * @param n the parameter name
201 * @return true if yes 197 * @return true if yes
202 */ 198 */
203 bool has_param(const string& n) const { 199 bool has_param(const string& n) const {
204 return has_field(n); } 200 return has_field(n); }
205 /** 201 /**
206 * retrieve the parameter (const version) 202 * retrieve the parameter (const version)
207 * @param n the parameter name 203 * @param n the parameter name
208 * @return the parameter value 204 * @return the parameter value
209 * @throw failed_lookup if there is no such parameter 205 * @throw failed_lookup if there is no such parameter
210 */ 206 */
211 const string& get_param(const string& n) const { 207 const string& get_param(const string& n) const {
212 return get_field(n); } 208 return get_field(n); }
213 209
214 /** 210 /**
215 * parse the OpenID key/value data. 211 * parse the OpenID key/value data.
216 * @param kv the OpenID key/value data 212 * @param kv the OpenID key/value data
217 */ 213 */
218 void parse_keyvalues(const string& kv) { 214 void parse_keyvalues(const string& kv) {
219 from_keyvalues(kv); } 215 from_keyvalues(kv); }
220 216
221 string append_query(const string& url,const char *prefix="openid.") const; 217 string append_query(const string& url,const char *prefix="openid.") const;
222 218
223 }; 219 };
224 220
225 struct openid_endpoint_t { 221 struct openid_endpoint_t {
226 string uri; 222 string uri;
227 string claimed_id; 223 string claimed_id;
228 string local_id; 224 string local_id;
229 225
230 openid_endpoint_t() { } 226 openid_endpoint_t() { }
231 openid_endpoint_t(const string& u,const string& cid,const string& lid) 227 openid_endpoint_t(const string& u,const string& cid,const string& lid)
232 : uri(u), claimed_id(cid), local_id(lid) { } 228 : uri(u), claimed_id(cid), local_id(lid) { }
233 229
234 bool operator==(const openid_endpoint_t& x) const { 230 bool operator==(const openid_endpoint_t& x) const {
235 return uri==x.uri && local_id==x.local_id; } 231 return uri==x.uri && local_id==x.local_id; }
236 bool operator<(const openid_endpoint_t& x) const { 232 bool operator<(const openid_endpoint_t& x) const {
237 int c; 233 int c;
238 return (c=strcmp(uri.c_str(),x.uri.c_str())) 234 return (c=strcmp(uri.c_str(),x.uri.c_str()))
239 ? (c<0) : (strcmp(local_id.c_str(),x.local_id.c_str())<0); } 235 ? (c<0) : (strcmp(local_id.c_str(),x.local_id.c_str())<0); }
240 }; 236 };
241 237
242 typedef util::output_iterator_proxy<openid_endpoint_t> 238 typedef util::output_iterator_proxy<openid_endpoint_t>
243 openid_endpoint_output_iterator; 239 openid_endpoint_output_iterator;
244 240
245} 241}
246 242
247#endif /* __OPKELE_TYPES_H */ 243#endif /* __OPKELE_TYPES_H */