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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.websocket;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.tomcat.util.res.StringManager;
/**
* Base class for the authentication methods used by the WebSocket client.
*/
public abstract class Authenticator {
private static final StringManager sm = StringManager.getManager(Authenticator.class);
private static final Pattern pattern = Pattern.compile("(\\w+)\\s*=\\s*(\"([^\"]+)\"|([^,=\"]+))\\s*,?");
/**
* Generate the authorization header value that will be sent to the server.
*
* @param requestUri The request URI
* @param authenticateHeader The server authentication header received
* @param userProperties The user information
*
* @return The generated authorization header value
*
* @throws AuthenticationException When an error occurs
*
* @deprecated Use {@link #getAuthorization(String, String, String, String, String)}. Will be removed in Tomcat
* 10.1.x
*/
@Deprecated
public String getAuthorization(String requestUri, String authenticateHeader, Map<String,Object> userProperties)
throws AuthenticationException {
return getAuthorization(requestUri, authenticateHeader,
(String) userProperties.get(Constants.WS_AUTHENTICATION_USER_NAME),
(String) userProperties.get(Constants.WS_AUTHENTICATION_PASSWORD),
(String) userProperties.get(Constants.WS_AUTHENTICATION_REALM));
}
/**
* Generate the authorization header value that will be sent to the server.
*
* @param requestUri The request URI
* @param authenticateHeader The server authentication header received
* @param userName The user name
* @param userPassword The user password
* @param userRealm The realm for which the provided username and password are valid. {@code null} to
* indicate all realms.
*
* @return The generated authorization header value
*
* @throws AuthenticationException When an error occurs
*/
public abstract String getAuthorization(String requestUri, String authenticateHeader, String userName,
String userPassword, String userRealm) throws AuthenticationException;
/**
* Get the authentication method.
*
* @return the authentication scheme
*/
public abstract String getSchemeName();
/**
* Utility method to parse the authentication header.
*
* @param authenticateHeader The server authenticate header received
*
* @return a map of authentication parameter names and values
*
* @deprecated Use {@link Authenticator#parseAuthenticateHeader(String)}. Will be removed in Tomcat 10.1.x onwards
*/
@Deprecated
public Map<String,String> parseWWWAuthenticateHeader(String authenticateHeader) {
return parseAuthenticateHeader(authenticateHeader);
}
/**
* Utility method to parse the authentication header.
*
* @param authenticateHeader The server authenticate header received
*
* @return a map of authentication parameter names and values
*/
public Map<String,String> parseAuthenticateHeader(String authenticateHeader) {
Matcher m = pattern.matcher(authenticateHeader);
Map<String,String> parameterMap = new HashMap<>();
while (m.find()) {
String key = m.group(1);
String qtedValue = m.group(3);
String value = m.group(4);
parameterMap.put(key, qtedValue != null ? qtedValue : value);
}
return parameterMap;
}
protected void validateUsername(String userName) throws AuthenticationException {
if (userName == null) {
throw new AuthenticationException(sm.getString("authenticator.nullUserName"));
}
}
protected void validatePassword(String password) throws AuthenticationException {
if (password == null) {
throw new AuthenticationException(sm.getString("authenticator.nullPassword"));
}
}
protected void validateRealm(String userRealm, String serverRealm) throws AuthenticationException {
if (userRealm == null) {
return;
}
userRealm = userRealm.trim();
if (userRealm.isEmpty()) {
return;
}
/*
* User has configured a realm. Only allow authentication to proceed if the realm in the authentication
* challenge matches (both BASIC and DIGEST are required to include a realm).
*/
if (serverRealm != null) {
serverRealm = serverRealm.trim();
if (userRealm.equals(serverRealm)) {
return;
}
}
throw new AuthenticationException(sm.getString("authenticator.realmMismatch", userRealm, serverRealm));
}
}
|
