1 package Catalyst::Plugin::RequireSSL;
4 use base qw/Class::Accessor::Fast/;
9 __PACKAGE__->mk_accessors( qw/_require_ssl _allow_ssl _ssl_strip_output/ );
16 if ( !$c->req->secure && $c->req->method ne "POST" ) {
17 my $redir = $c->_redirect_uri('https');
18 if ( $c->config->{require_ssl}->{disabled} ) {
19 $c->log->warn( "RequireSSL: Would have redirected to $redir" );
22 $c->_ssl_strip_output(1);
23 $c->res->redirect( $redir );
24 $c->detach if $c->config->{require_ssl}->{detach_on_redirect};
38 # Do not redirect static files (only works with Static::Simple)
39 if ( $c->isa( "Catalyst::Plugin::Static::Simple" ) ) {
40 return $c->next::method(@_) if $c->_static_file;
43 # redirect back to non-SSL mode
47 # we're not in SSL mode
48 last REDIRECT if !$c->req->secure;
50 last REDIRECT if $c->req->method eq "POST";
51 # we're already required to be in SSL for this request
52 last REDIRECT if $c->_require_ssl;
53 # or the user doesn't want us to redirect
54 last REDIRECT if $c->config->{require_ssl}->{remain_in_ssl} || $c->_allow_ssl;
56 $c->res->redirect( $c->_redirect_uri('http') );
59 # do not allow any output to be displayed on the insecure page
60 if ( $c->_ssl_strip_output ) {
64 return $c->next::method(@_);
72 # disable the plugin when running under certain engines which don't
74 if ( $c->engine =~ /Catalyst::Engine::HTTP/ ) {
75 $c->config->{require_ssl}->{disabled} = 1;
76 $c->log->warn( "RequireSSL: Disabling SSL redirection while running "
77 . "under " . $c->engine );
82 my ( $c, $type ) = @_;
84 if ( !$c->config->{require_ssl}->{$type} ) {
85 my $req_uri = $c->req->uri;
86 $c->config->{require_ssl}->{$type} =
87 join(':', $req_uri->host, $req_uri->_port);
90 $c->config->{require_ssl}->{$type} =~ s/\/+$//;
92 my $redir = $c->req->uri->clone;
93 $redir->scheme($type);
94 $redir->host_port($c->config->{require_ssl}->{$type});
96 if ( $c->config->{require_ssl}->{no_cache} ) {
97 delete $c->config->{require_ssl}->{$type};
108 Catalyst::Plugin::RequireSSL - Force SSL mode on select pages
114 MyApp->setup( qw/RequireSSL/ );
116 MyApp->config->{require_ssl} = {
117 https => 'secure.mydomain.com',
118 http => 'www.mydomain.com',
121 detach_on_redirect => 1,
124 # in any controller methods that should be secured
129 B<Note:> This module is considered to be deprecated for most purposes. Consider
130 using L<Catalyst::ActionRole::RequireSSL> instead.
132 Use this plugin if you wish to selectively force SSL mode on some of your web
133 pages, for example a user login form or shopping cart.
135 Simply place $c->require_ssl calls in any controller method you wish to be
138 This plugin will automatically disable itself if you are running under the
139 standalone HTTP::Daemon Catalyst server. A warning message will be printed to
140 the log file whenever an SSL redirect would have occurred.
144 If you utilize different servers or hostnames for non-SSL and SSL requests,
145 and you rely on a session cookie to determine redirection (i.e for a login
146 page), your cookie must be visible to both servers. For more information, see
147 the documentation for the Session plugin you are using.
151 Configuration is optional. You may define the following configuration values:
155 If your SSL domain name is different from your non-SSL domain, set this value.
157 http => $non_ssl_host
159 If you have set the https value above, you must also set the hostname of your
164 If you'd like your users to remain in SSL mode after visiting an SSL-required
165 page, you can set this option to 1. By default, this option is disabled and
166 users will be redirected back to non-SSL mode as soon as possible.
170 If you have a wildcard certificate you will need to set this option if you are
171 using multiple domains on one instance of Catalyst.
175 By default C<< $c->require_ssl >> only calls C<< $c->response->redirect >> but
176 does not stop request processing (so it returns and subsequent statements are
177 run). This is probably not what you want. If you set this option to a true
178 value C<< $c->require_ssl >> will call C<< $c->detach >> when it redirects.
184 Call require_ssl in any controller method you wish to be secured.
188 The browser will be redirected to the same path on your SSL server. POST
189 requests are never redirected.
193 Call allow_ssl in any controller method you wish to access both in SSL and
198 The browser will not be redirected, independently of whether the request was
199 made to the SSL or non-SSL server.
203 Disables this plugin if running under an engine which does not support SSL.
207 Performs the redirect to SSL url if required.
211 When viewing an SSL-required page that uses static files served from the
212 Static plugin, the static files are redirected to the non-SSL path.
214 In order to get the correct behaviour where static files are not redirected,
215 you should use the Static::Simple plugin or always serve static files
216 directly from your web server.
220 L<Catalyst>, L<Catalyst::ActionRole::RequireSSL>,
221 L<Catalyst::Plugin::Static::Simple>
225 Andy Grundman, <andy@hybridized.org>
229 Simon Elliott <simon@browsing.co.uk> (support for wildcards)
233 This program is free software, you can redistribute it and/or modify it under
234 the same terms as Perl itself.