blob: c1a694f1482cd7b81994b51783898f1b71c5cdb8 (
plain)
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
|
/*
*
* 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.qpid.server.security.auth.manager;
import java.security.Principal;
import javax.security.sasl.SaslException;
import javax.security.sasl.SaslServer;
import org.apache.qpid.common.Closeable;
import org.apache.qpid.server.security.auth.AuthenticationResult;
/**
* Implementations of the AuthenticationManager are responsible for determining
* the authenticity of a user's credentials.
* <p>
* If the authentication is successful, the manager is responsible for producing an
* {@link AuthenticationResult} containing the user's main {@link Principal} and zero or
* more other implementation-specific principals.
* </p>
* <p>
* The {@link #initialise()} method is responsible for registering SASL mechanisms required by
* the manager. The {@link #close()} method must reverse this registration.
* </p>
*/
public interface AuthenticationManager extends Closeable
{
/** The name for the required SASL Server mechanisms */
public static final String PROVIDER_NAME= "AMQSASLProvider-Server";
/**
* Initialise the authentication plugin.
*
*/
void initialise();
/**
* Gets the SASL mechanisms known to this manager.
*
* @return SASL mechanism names, space separated.
*/
String getMechanisms();
/**
* Creates a SASL server for the specified mechanism name for the given
* fully qualified domain name.
*
* @param mechanism mechanism name
* @param localFQDN domain name
* @param externalPrincipal externally authenticated Principal
* @return SASL server
* @throws SaslException
*/
SaslServer createSaslServer(String mechanism, String localFQDN, Principal externalPrincipal) throws SaslException;
/**
* Authenticates a user using SASL negotiation.
*
* @param server SASL server
* @param response SASL response to process
*
* @return authentication result
*/
AuthenticationResult authenticate(SaslServer server, byte[] response);
/**
* Authenticates a user using their username and password.
*
* @param username username
* @param password password
*
* @return authentication result
*/
AuthenticationResult authenticate(String username, String password);
}
|
