-
-
Notifications
You must be signed in to change notification settings - Fork 268
Expand file tree
/
Copy pathOAuth.html
More file actions
202 lines (128 loc) · 8.95 KB
/
Copy pathOAuth.html
File metadata and controls
202 lines (128 loc) · 8.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: OAuth
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "OAuth";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (O)</a> »
<span class="title">OAuth</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: OAuth
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/oauth/oauth.rb<span class="defines">,<br />
lib/oauth/client.rb,<br /> lib/oauth/helper.rb,<br /> lib/oauth/server.rb,<br /> lib/oauth/version.rb,<br /> lib/oauth/consumer.rb,<br /> lib/oauth/optional.rb,<br /> lib/oauth/signature.rb,<br /> lib/oauth/errors/error.rb,<br /> lib/oauth/tokens/token.rb,<br /> lib/oauth/client/helper.rb,<br /> lib/oauth/request_proxy.rb,<br /> lib/oauth/errors/problem.rb,<br /> lib/oauth/signature/base.rb,<br /> lib/oauth/oauth_test_helper.rb,<br /> lib/oauth/request_proxy/base.rb,<br /> lib/oauth/signature/rsa/sha1.rb,<br /> lib/oauth/errors/unauthorized.rb,<br /> lib/oauth/signature/hmac/sha1.rb,<br /> lib/oauth/signature/plaintext.rb,<br /> lib/oauth/tokens/access_token.rb,<br /> lib/oauth/tokens/server_token.rb,<br /> lib/oauth/tokens/request_token.rb,<br /> lib/oauth/signature/hmac/sha256.rb,<br /> lib/oauth/tokens/consumer_token.rb,<br /> lib/oauth/request_proxy/net_http.rb,<br /> lib/oauth/request_proxy/curb_request.rb,<br /> lib/oauth/request_proxy/mock_request.rb,<br /> lib/oauth/request_proxy/rack_request.rb,<br /> lib/oauth/request_proxy/jabber_request.rb,<br /> lib/oauth/request_proxy/em_http_request.rb,<br /> lib/oauth/request_proxy/typhoeus_request.rb,<br /> lib/oauth/request_proxy/rest_client_request.rb,<br /> lib/oauth/request_proxy/action_dispatch_request.rb,<br /> lib/oauth/request_proxy/action_controller_request.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="OAuth/Client.html" title="OAuth::Client (module)">Client</a></span>, <span class='object_link'><a href="OAuth/Helper.html" title="OAuth::Helper (module)">Helper</a></span>, <span class='object_link'><a href="OAuth/OAuthTestHelper.html" title="OAuth::OAuthTestHelper (module)">OAuthTestHelper</a></span>, <span class='object_link'><a href="OAuth/Optional.html" title="OAuth::Optional (module)">Optional</a></span>, <span class='object_link'><a href="OAuth/RequestProxy.html" title="OAuth::RequestProxy (module)">RequestProxy</a></span>, <span class='object_link'><a href="OAuth/Signature.html" title="OAuth::Signature (module)">Signature</a></span>, <span class='object_link'><a href="OAuth/Version.html" title="OAuth::Version (module)">Version</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="OAuth/AccessToken.html" title="OAuth::AccessToken (class)">AccessToken</a></span>, <span class='object_link'><a href="OAuth/Consumer.html" title="OAuth::Consumer (class)">Consumer</a></span>, <span class='object_link'><a href="OAuth/ConsumerToken.html" title="OAuth::ConsumerToken (class)">ConsumerToken</a></span>, <span class='object_link'><a href="OAuth/Error.html" title="OAuth::Error (class)">Error</a></span>, <span class='object_link'><a href="OAuth/Problem.html" title="OAuth::Problem (class)">Problem</a></span>, <span class='object_link'><a href="OAuth/RequestToken.html" title="OAuth::RequestToken (class)">RequestToken</a></span>, <span class='object_link'><a href="OAuth/Server.html" title="OAuth::Server (class)">Server</a></span>, <span class='object_link'><a href="OAuth/ServerToken.html" title="OAuth::ServerToken (class)">ServerToken</a></span>, <span class='object_link'><a href="OAuth/Token.html" title="OAuth::Token (class)">Token</a></span>, <span class='object_link'><a href="OAuth/Unauthorized.html" title="OAuth::Unauthorized (class)">Unauthorized</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="OUT_OF_BAND-constant" class="">OUT_OF_BAND =
<div class="docstring">
<div class="discussion">
<p>Out-Of-Band callback token value.<br />
OAuth 1.0 and 1.0a both support out-of-band flows, where callbacks cannot be used.<br />
See RFC 5849 (OAuth 1.0), Section 6.1.1: Obtaining an Unauthorized Request Token<br />
and the 1.0a errata. Providers treating “oob” as the callback URL indicate that<br />
the verifier (for 1.0a) will be communicated out of band to the Consumer.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>oob</span><span class='tstring_end'>"</span></span></pre></dd>
<dt id="PARAMETERS-constant" class="">PARAMETERS =
<div class="docstring">
<div class="discussion">
<p>OAuth parameter keys this library recognizes when normalizing/signing requests.<br />
Notes on 1.0 vs 1.0a:</p>
<ul>
<li>oauth_verifier: Introduced by OAuth 1.0a. Returned to the Consumer after user<br />
authorization and required when exchanging a Request Token for an Access Token<br />
(Section 6.3.1 in RFC 5849 / 1.0a change).</li>
<li>oauth_callback: Present in 1.0; 1.0a clarified that the Consumer MUST send it when<br />
obtaining a Request Token (or use “oob”) and that the Service Provider MUST return<br />
oauth_callback_confirmed=true with the Request Token response to prevent session<br />
fixation attacks. Note that oauth_callback_confirmed is a response parameter, not<br />
a request signing parameter, and thus is not listed here.<br />
Other keys are common to both 1.0 and 1.0a.</li>
</ul>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_callback</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_consumer_key</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_token</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_signature_method</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_timestamp</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_nonce</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_verifier</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_version</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_signature</span><span class='words_sep'>
</span><span class='words_sep'> </span><span class='tstring_content'>oauth_body_hash</span><span class='words_sep'>
</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="RESERVED_CHARACTERS-constant" class="">RESERVED_CHARACTERS =
<div class="docstring">
<div class="discussion">
<p>reserved character regexp, per section 5.1</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[^a-zA-Z0-9\-._~]</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Mon Sep 15 00:31:56 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.4.5).
</div>
</div>
</body>
</html>