1 /*
2 * Copyright 2012-2025 CodeLibs Project and the Others.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.codelibs.fess.sso;
17
18 import org.codelibs.fess.app.web.base.login.FessLoginAssist.LoginCredentialResolver;
19 import org.codelibs.fess.mylasta.action.FessUserBean;
20 import org.lastaflute.web.login.credential.LoginCredential;
21 import org.lastaflute.web.response.ActionResponse;
22
23 /**
24 * Interface for SSO (Single Sign-On) authenticator implementations.
25 *
26 * This interface defines the contract for SSO authentication providers that can be
27 * integrated with Fess. Implementations handle specific SSO protocols like SAML,
28 * OAuth, SPNEGO, or other authentication mechanisms. Each authenticator is responsible
29 * for obtaining login credentials, resolving user information, and managing SSO
30 * lifecycle operations like logout and metadata exchange.
31 */
32 public interface SsoAuthenticator {
33
34 /**
35 * Gets the login credential for SSO authentication.
36 * @return The login credential.
37 */
38 LoginCredential getLoginCredential();
39
40 /**
41 * Resolves credential using the provided resolver.
42 * @param resolver The login credential resolver.
43 */
44 void resolveCredential(LoginCredentialResolver resolver);
45
46 /**
47 * Gets the action response for the specified SSO response type.
48 * @param responseType The type of SSO response required.
49 * @return The action response.
50 */
51 ActionResponse getResponse(SsoResponseType responseType);
52
53 /**
54 * Performs logout for the specified user.
55 * @param user The user to logout.
56 * @return The logout URL or null if not applicable.
57 */
58 String logout(FessUserBean user);
59
60 }