-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
AuthToken.java
169 lines (149 loc) · 6.05 KB
/
AuthToken.java
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
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.api.security;
import org.apache.commons.lang3.StringUtils;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
import org.neo4j.kernel.api.security.exception.InvalidAuthTokenException;
import org.neo4j.string.UTF8;
import static java.lang.String.format;
import static org.neo4j.helpers.collection.MapUtil.map;
public interface AuthToken
{
String SCHEME_KEY = "scheme";
String PRINCIPAL = "principal";
String CREDENTIALS = "credentials";
String REALM_KEY = "realm";
String PARAMETERS = "parameters";
String NEW_CREDENTIALS = "new_credentials";
String BASIC_SCHEME = "basic";
String NATIVE_REALM = "native";
static String safeCast( String key, Map<String,Object> authToken ) throws InvalidAuthTokenException
{
Object value = authToken.get( key );
if ( value == null )
{
throw invalidToken( "missing key `" + key + "`" );
}
else if ( !(value instanceof String) )
{
throw invalidToken( "the value associated with the key `" + key + "` must be a String but was: "
+ value.getClass().getSimpleName() );
}
return (String) value;
}
static byte[] safeCastCredentials( String key, Map<String,Object> authToken ) throws InvalidAuthTokenException
{
Object value = authToken.get( key );
if ( value == null )
{
throw invalidToken( "missing key `" + key + "`" );
}
else if ( !(value instanceof byte[]) )
{
throw invalidToken( "the value associated with the key `" + key + "` must be a byte[] but was: "
+ value.getClass().getSimpleName() );
}
return (byte[]) value;
}
static Map<String,Object> safeCastMap( String key, Map<String,Object> authToken )
throws InvalidAuthTokenException
{
Object value = authToken.get( key );
if ( value == null )
{
return Collections.emptyMap();
}
else if ( value instanceof Map )
{
return (Map<String,Object>) value;
}
else
{
throw new InvalidAuthTokenException(
"The value associated with the key `" + key + "` must be a Map but was: " +
value.getClass().getSimpleName() );
}
}
static void clearCredentials( Map<String,Object> authToken )
{
Object credentials = authToken.get( CREDENTIALS );
if ( credentials != null && credentials instanceof byte[] )
{
Arrays.fill( (byte[]) credentials, (byte) 0 );
}
Object newCredentials = authToken.get( NEW_CREDENTIALS );
if ( newCredentials != null && newCredentials instanceof byte[] )
{
Arrays.fill( (byte[]) newCredentials, (byte) 0 );
}
}
static InvalidAuthTokenException invalidToken( String explanation )
{
if ( StringUtils.isNotEmpty( explanation ) && !explanation.matches( "^[,.:;].*" ) )
{
explanation = ", " + explanation;
}
return new InvalidAuthTokenException( format( "Unsupported authentication token%s", explanation ) );
}
static Map<String,Object> newBasicAuthToken( String username, byte[] password )
{
return map( AuthToken.SCHEME_KEY, BASIC_SCHEME, AuthToken.PRINCIPAL, username, AuthToken.CREDENTIALS,
password );
}
static Map<String,Object> newBasicAuthToken( String username, byte[] password, String realm )
{
return map( AuthToken.SCHEME_KEY, BASIC_SCHEME, AuthToken.PRINCIPAL, username, AuthToken.CREDENTIALS, password,
AuthToken.REALM_KEY, realm );
}
static Map<String,Object> newCustomAuthToken( String principle, byte[] credentials, String realm, String scheme )
{
return map( AuthToken.SCHEME_KEY, scheme, AuthToken.PRINCIPAL, principle, AuthToken.CREDENTIALS, credentials,
AuthToken.REALM_KEY, realm );
}
static Map<String,Object> newCustomAuthToken( String principle, byte[] credentials, String realm, String scheme,
Map<String,Object> parameters )
{
return map( AuthToken.SCHEME_KEY, scheme, AuthToken.PRINCIPAL, principle, AuthToken.CREDENTIALS, credentials,
AuthToken.REALM_KEY, realm, AuthToken.PARAMETERS, parameters );
}
// For testing purposes only
static Map<String,Object> newBasicAuthToken( String username, String password )
{
return newBasicAuthToken( username, UTF8.encode( password ) );
}
// For testing purposes only
static Map<String,Object> newBasicAuthToken( String username, String password, String realm )
{
return newBasicAuthToken( username, UTF8.encode( password ), realm );
}
// For testing purposes only
static Map<String,Object> newCustomAuthToken( String principle, String credentials, String realm, String scheme )
{
return newCustomAuthToken( principle, UTF8.encode( credentials ), realm, scheme );
}
// For testing purposes only
static Map<String,Object> newCustomAuthToken( String principle, String credentials, String realm, String scheme,
Map<String,Object> parameters )
{
return newCustomAuthToken( principle, UTF8.encode( credentials ), realm, scheme, parameters );
}
}