summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2008-02-08 21:18:43 (UTC)
committer Michael Krelin <hacker@klever.net>2008-02-08 21:18:43 (UTC)
commit6c82575a47283fcd7fdd0cf42b96e90a0888c58c (patch) (unidiff)
tree22f2b1018db45c3561ed099a676c7f4314b7dcb4 /include
parent9e902e373ba72fd8725c5a1ffdfdc0447b664369 (diff)
downloadlibopkele-6c82575a47283fcd7fdd0cf42b96e90a0888c58c.zip
libopkele-6c82575a47283fcd7fdd0cf42b96e90a0888c58c.tar.gz
libopkele-6c82575a47283fcd7fdd0cf42b96e90a0888c58c.tar.bz2
further doxygenation of basic_OP
Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/basic_op.h77
1 files changed, 75 insertions, 2 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h
index 4daed02..a0f0af0 100644
--- a/include/opkele/basic_op.h
+++ b/include/opkele/basic_op.h
@@ -11,28 +11,101 @@ namespace opkele {
11 class basic_OP { 11 class basic_OP {
12 public: 12 public:
13 /**
14 * The request mode for the request being processed
15 */
13 mode_t mode; 16 mode_t mode;
17 /**
18 * association used in transaction. reset in case of dumb operation
19 */
14 assoc_t assoc; 20 assoc_t assoc;
21 /**
22 * true if the request is openid2 request
23 */
15 bool openid2; 24 bool openid2;
25 /**
26 * The return_to RP endpoint
27 */
16 string return_to; 28 string return_to;
29 /**
30 * The realm we authenticate for
31 */
17 string realm; 32 string realm;
33 /**
34 * Claimed identifier
35 */
18 string claimed_id; 36 string claimed_id;
37 /**
38 * The OP-Local identifier
39 */
19 string identity; 40 string identity;
41 /**
42 * The invalidate handle for the reply request
43 */
20 string invalidate_handle; 44 string invalidate_handle;
21 45
22 void reset_vars(); 46 void reset_vars();
23 47
48 /**
49 * @name Request information access
50 * Setting and retrieval of the information pertaining to the request being processed
51 * @{
52 */
53 /**
54 * Check if the RP expects us to get back to them.
55 * @return true if RP supplied return_to URL
56 */
24 bool has_return_to() const; 57 bool has_return_to() const;
58 /**
59 * Find out where the RP is waiting for us.
60 * @return the return_to URL supplied
61 * @throw no_return_to if no return_to is supplied with the request
62 */
25 const string& get_return_to() const; 63 const string& get_return_to() const;
26 64
65 /**
66 * Find out what realm we are authenticating user for
67 * @return the realm
68 */
27 const string& get_realm() const; 69 const string& get_realm() const;
28 70
71 /**
72 * Check if request is about identity
73 * @return true if so
74 */
29 bool has_identity() const; 75 bool has_identity() const;
76 /**
77 * Get claimed identifier supplied with the request
78 * @return claimed identifier
79 * @throw non_identity if request is not about identity
80 */
30 const string& get_claimed_id() const; 81 const string& get_claimed_id() const;
82 /**
83 * Get the identity (OP-Local identifier) being confirmed
84 * @return identity
85 * @throw non_identity if request is not about identity
86 */
31 const string& get_identity() const; 87 const string& get_identity() const;
32 88
89 /**
90 * Is identifier supposed to be selected on our side?
91 * @return true if identity is a special identifier select URI
92 */
33 bool is_id_select() const; 93 bool is_id_select() const;
34 94
35 void select_identity(const string& c,const string& i); 95 /**
36 void set_claimed_id(const string& c); 96 * Select the identity for identifier select request
97 * @param cid claimed identifier
98 * @param lid local identifier
99 */
100 void select_identity(const string& cid,const string& lid);
101 /**
102 * Set claimed identifier (for instance if it's supposed to have
103 * fragment part)
104 * @param cid claimed identifier
105 */
106 void set_claimed_id(const string& cid);
107 /**
108 * @}
109 */
37 110
38 /** @name OpenID operations 111 /** @name OpenID operations