xref: /OpenGrok/plugins/src/main/java/opengrok/auth/plugin/decoders/UserPrincipalDecoder.java (revision aa6abf429bacc2c0baa482bff3022e77ef23c183)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * See LICENSE.txt included in this distribution for the specific
9  * language governing permissions and limitations under the License.
10  *
11  * When distributing Covered Code, include this CDDL HEADER in each
12  * file and include the License file at LICENSE.txt.
13  * If applicable, add the following below this CDDL HEADER, with the
14  * fields enclosed by brackets "[]" replaced with your own identifying
15  * information: Portions Copyright [yyyy] [name of copyright owner]
16  *
17  * CDDL HEADER END
18  */
19 
20 /*
21  * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
22  */
23 package opengrok.auth.plugin.decoders;
24 
25 import jakarta.servlet.http.HttpServletRequest;
26 import opengrok.auth.plugin.entity.User;
27 
28 import java.util.logging.Level;
29 import java.util.logging.Logger;
30 
31 /**
32  * Get authenticated user principal and use it to create User object.
33  * This works e.g. with HTTP Basic authentication headers as per RFC 7617.
34  *
35  * @author Vladimir Kotal
36  */
37 public class UserPrincipalDecoder implements IUserDecoder {
38 
39     private static final Logger LOGGER = Logger.getLogger(UserPrincipalDecoder.class.getName());
40 
41     @Override
fromRequest(HttpServletRequest request)42     public User fromRequest(HttpServletRequest request) {
43         if (request.getUserPrincipal() == null) {
44             return null;
45         }
46 
47         String username = request.getUserPrincipal().getName();
48         if (username == null || username.isEmpty()) {
49             LOGGER.log(Level.WARNING,
50                     "Can not construct User object: cannot get user principal from: {0}",
51                     request);
52             return null;
53         }
54 
55         return new User(username);
56     }
57 }