annotate servlet/src/digilib/auth/AuthOpsImpl.java @ 181:afe7ff98bb71

Servlet version 1.18b1 - new transfer mode "rawfile" with mime-type application/octet-stream - finally proper logging with Log4J! - therefore a lot of debugging-prints changed - the Util class is now useless - ServletOps and FileOps are now purely static
author robcast
date Fri, 21 Nov 2003 00:17:31 +0100
parents 3b8797fc3e90
children 26b2a74e2fe5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
1 /* AuthOps -- Authentication class implementation
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
2
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
3 Digital Image Library servlet components
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
4
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
5 Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
6
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
10 option) any later version.
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
11
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
14
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
18
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
19 */
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
20
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
21 package digilib.auth;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
22
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
23 import java.util.List;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
24 import java.util.ListIterator;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
25
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
26 import javax.servlet.http.HttpServletRequest;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
27
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
28 import org.apache.log4j.Logger;
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
29
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
30 import digilib.Utils;
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
31 import digilib.servlet.DigilibRequest;
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
32
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
33 /** Basic implementation of AuthOps interface.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
34 *
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
35 * Provides basic implementations. Only rolesForPath needs to be implemented
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
36 * by specific implementations.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
37 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
38 public abstract class AuthOpsImpl implements AuthOps {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
39
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
40 /** general logger for this class */
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
41 protected Logger logger = Logger.getLogger(this.getClass());
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
42
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
43 /** Default constructor. */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
44 public AuthOpsImpl() {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
45 try {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
46 init();
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
47 } catch (AuthOpException e) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
48 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
49 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
50
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
51 /** Constructor taking an utils object.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
52 * @param u utils object.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
53 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
54 public AuthOpsImpl(Utils u) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
55 try {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
56 init();
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
57 } catch (AuthOpException e) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
58 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
59 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
60
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
61 /** Test if the request is allowed to access filepath.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
62 * @param filepath filepath to be acessed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
63 * @param request Request with user information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
64 * @throws AuthOpException Exception thrown on error.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
65 * @return true if the request is allowed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
66 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
67 public boolean isAuthRequired(String filepath, HttpServletRequest request) throws AuthOpException {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
68 // check permissions
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
69 List rolesRequired = rolesForPath(filepath, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
70 return (rolesRequired != null);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
71 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
72
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
73 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
74 * @see digilib.auth.AuthOps#isAuthRequired(digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
75 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
76 public boolean isAuthRequired(DigilibRequest request)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
77 throws AuthOpException {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
78 // check permissions
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
79 List rolesRequired = rolesForPath(request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
80 return (rolesRequired != null);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
81 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
82
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
83 /** Return authorization roles needed for request.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
84 *
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
85 * Returns a list of authorization roles that would be allowed to access the
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
86 * specified path. The location information of the request is considered also.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
87 * @param filepath filepath to be accessed.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
88 * @param request ServletRequest with address information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
89 * @throws AuthOpException Exception thrown on error.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
90 * @return List of Strings with role names.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
91 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
92 public boolean isAuthorized(String filepath, HttpServletRequest request) throws AuthOpException {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
93 List rolesAllowed = rolesForPath(filepath, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
94 return isRoleAuthorized(rolesAllowed, request);
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
95 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
96
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
97 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
98 * @see digilib.auth.AuthOps#isAuthorized(digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
99 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
100 public boolean isAuthorized(DigilibRequest request)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
101 throws AuthOpException {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
102 List rolesAllowed = rolesForPath(request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
103 return isRoleAuthorized(rolesAllowed, request);
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
104 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
105
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
106 /** Test request authorization against a list of roles.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
107 * @param roles List of Strings with role names.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
108 * @param request ServletRequest with address information.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
109 * @return true if the user information in the request authorizes one of the roles.
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
110 */
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
111 public boolean isRoleAuthorized(List roles, HttpServletRequest request) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
112 ListIterator r = roles.listIterator();
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
113 String s = "";
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
114 while (r.hasNext()) {
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
115 s = (String)r.next();
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
116 logger.debug("Testing role: "+s);
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
117 if (request.isUserInRole(s)) {
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
118 logger.debug("Role Authorized");
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
119 return true;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
120 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
121 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
122 return false;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
123 }
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
124
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
125 /**
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
126 * @see digilib.auth.AuthOps#isRoleAuthorized(java.util.List, digilib.servlet.DigilibRequest)
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
127 */
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
128 public boolean isRoleAuthorized(List roles, DigilibRequest request) {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
129 ListIterator r = roles.listIterator();
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
130 String s = "";
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
131 while (r.hasNext()) {
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
132 s = (String)r.next();
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
133 logger.debug("Testing role: "+s);
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
134 if (((HttpServletRequest)request.getServletRequest()).isUserInRole(s)) {
181
afe7ff98bb71 Servlet version 1.18b1
robcast
parents: 73
diff changeset
135 logger.debug("Role Authorized");
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
136 return true;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
137 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
138 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
139 return false;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
140 }
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
141
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
142 public abstract void init() throws AuthOpException;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
143
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
144 public abstract List rolesForPath(String filepath, HttpServletRequest request) throws AuthOpException;
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
145
73
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
146 public abstract List rolesForPath(DigilibRequest request) throws AuthOpException;
3b8797fc3e90 New servlet version 1.5b.
robcast
parents: 1
diff changeset
147
1
0ff3ede32060 Initial revision
robcast
parents:
diff changeset
148 }