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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
package OAuth::Lite2::Server::Error;
use strict;
use warnings;
use overload
q{""} => sub { sprintf q{%s: %s}, $_[0]->type, $_[0]->description },
fallback => 1;
=head1 NAME
OAuth::Lite2::Server::Error - OAuth 2.0 server errors
=head1 SYNOPSIS
# At End-User Endpoint
try {
if ($something_wrong) {
OAuth::Lite2::Server::Error::InvalidRequest->throw(
description => q{Something wrong},
# state => q{foo},
);
}
} catch {
if ($_->isa("OAuth::Lite2::Server::Error")) {
my $uri = URI->new( $client_callback_uri );
my %error_params = ( error => $_->type );
$error_params{error_description} = $_->description if $_->description;
$error_params{state} = $_->state if $_->state;
$uri->query_form(%error_params);
$your_app->redirect( $uri->as_string );
} else {
# Internal Server Error
}
};
# At token-endpoint
try {
} catch {
if ($_->isa("OAuth::Lite2::Server::Error")) {
my %error_params = ( error => $_->type );
$error_params{error_description} = $_->description if $_->description;
$error_params{scope} = $_->scope if $_->scope;
$req->new_response($_->code,
[ "Content-Type" => $formatter->type, "Cache-Control" => "no-store" ],
[ $formatter->format(\%error_params) ],
);
} else {
# rethrow
die $_;
}
};
=head1 DESCRIPTION
OAuth 2.0 error classes.
See
L<http://tools.ietf.org/html/draft-ietf-oauth-v2-09>,
L<http://tools.ietf.org/html/rfc6749>,
=head1 METHODS
There are following errors
=head1 ERRORS
=over 4
=item OAuth::Lite2::Server::Error::InvalidRequest
=item OAuth::Lite2::Server::Error::InvalidClient
=item OAuth::Lite2::Server::Error::UnauthorizedClient
=item OAuth::Lite2::Server::Error::RedirectURIMismatch
=item OAuth::Lite2::Server::Error::AccessDenied
=item OAuth::Lite2::Server::Error::UnsupportedResponseType
=item OAuth::Lite2::Server::Error::UnsupportedResourceType
=item OAuth::Lite2::Server::Error::InvalidGrant
=item OAuth::Lite2::Server::Error::UnsupportedGrantType
=item OAuth::Lite2::Server::Error::InvalidScope
=item OAuth::Lite2::Server::Error::InvalidToken
=item OAuth::Lite2::Server::Error::ExpiredTokenLegacy
=item OAuth::Lite2::Server::Error::ExpiredToken
=item OAuth::Lite2::Server::Error::InsufficientScope
=item OAuth::Lite2::Server::Error::InvalidServerState
=item OAuth::Lite2::Server::Error::TemporarilyUnavailable
=item OAuth::Lite2::Server::Error::ServerError
=back
=cut
sub new {
my ($class, %args) = @_;
bless {
description => $args{description} || '',
state => $args{state} || '',
code => $args{code} || 400,
}, $class;
}
sub throw {
my ($class, %args) = @_;
die $class->new(%args);
}
sub code { $_[0]->{code} }
sub type { die "abstract method" }
sub description { $_[0]->{description} }
sub state { $_[0]->{state} }
# OAuth Server Error
package OAuth::Lite2::Server::Error::InvalidRequest;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub type { "invalid_request" }
package OAuth::Lite2::Server::Error::InvalidClient;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_client" }
package OAuth::Lite2::Server::Error::UnauthorizedClient;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "unauthorized_client" }
package OAuth::Lite2::Server::Error::RedirectURIMismatch;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "redirect_uri_mismatch" }
package OAuth::Lite2::Server::Error::AccessDenied;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "access_denied" }
package OAuth::Lite2::Server::Error::UnsupportedResponseType;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub type { "unsupported_response_type" }
package OAuth::Lite2::Server::Error::UnsupportedResourceType;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub type { "unsupported_resource_type" }
package OAuth::Lite2::Server::Error::InvalidGrant;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_grant" }
package OAuth::Lite2::Server::Error::UnsupportedGrantType;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub type { "unsupported_grant_type" }
package OAuth::Lite2::Server::Error::InvalidScope;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_scope" }
package OAuth::Lite2::Server::Error::InvalidToken;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_token" }
package OAuth::Lite2::Server::Error::ExpiredTokenLegacy;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "expired_token" }
package OAuth::Lite2::Server::Error::ExpiredToken;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_token" }
sub description { "The access token expired" }
package OAuth::Lite2::Server::Error::InsufficientScope;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "insufficient_scope" }
package OAuth::Lite2::Server::Error::InvalidServerState;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 401 }
sub type { "invalid_server_state" }
# Generally, the client knows the state of the server by HTTP Status Code.
package OAuth::Lite2::Server::Error::TemporarilyUnavailable;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 503 }
sub type { "temporarily_unavailable" }
package OAuth::Lite2::Server::Error::ServerError;
our @ISA = qw(OAuth::Lite2::Server::Error);
sub code { 500 }
sub type { "server_error" }
package OAuth::Lite2::Server::Error;
=head1 AUTHOR
Ryo Ito, E<lt>ritou.06@gmail.comE<gt>
Lyo Kato, E<lt>lyo.kato@gmail.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2010 by Lyo Kato
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.
=cut
1;
|
