1 /*
2  * Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package sun.security.action;
27 
28 import java.security.AccessController;
29 
30 /**
31  * A convenience class for retrieving the boolean value of a system property
32  * as a privileged action.
33  *
34  * <p>An instance of this class can be used as the argument of
35  * <code>AccessController.doPrivileged</code>.
36  *
37  * <p>The following code retrieves the boolean value of the system
38  * property named <code>"prop"</code> as a privileged action:
39  *
40  * <pre>
41  * boolean b = java.security.AccessController.doPrivileged
42  *              (new GetBooleanAction("prop")).booleanValue();
43  * </pre>
44  *
45  * @author Roland Schemers
46  * @see java.security.PrivilegedAction
47  * @see java.security.AccessController
48  * @since 1.2
49  */
50 
51 public class GetBooleanAction
52         implements java.security.PrivilegedAction<Boolean> {
53     private String theProp;
54 
55     /**
56      * Constructor that takes the name of the system property whose boolean
57      * value needs to be determined.
58      *
59      * @param theProp the name of the system property.
60      */
GetBooleanAction(String theProp)61     public GetBooleanAction(String theProp) {
62         this.theProp = theProp;
63     }
64 
65     /**
66      * Determines the boolean value of the system property whose name was
67      * specified in the constructor.
68      *
69      * @return the <code>Boolean</code> value of the system property.
70      */
run()71     public Boolean run() {
72         return Boolean.getBoolean(theProp);
73     }
74 
75     /**
76      * Convenience method to get a property without going through doPrivileged
77      * if no security manager is present. This is unsafe for inclusion in a
78      * public API but allowable here since this class is now encapsulated.
79      *
80      * Note that this method performs a privileged action using caller-provided
81      * inputs. The caller of this method should take care to ensure that the
82      * inputs are not tainted and the returned property is not made accessible
83      * to untrusted code if it contains sensitive information.
84      *
85      * @param theProp the name of the system property.
86      */
87     @SuppressWarnings("removal")
privilegedGetProperty(String theProp)88     public static boolean privilegedGetProperty(String theProp) {
89         if (System.getSecurityManager() == null) {
90             return Boolean.getBoolean(theProp);
91         } else {
92             return AccessController.doPrivileged(
93                     new GetBooleanAction(theProp));
94         }
95     }
96 }
97