src/java.base/share/classes/java/io/SerializablePermission.java
author jboes
Tue, 24 Sep 2019 09:43:43 +0100
changeset 58288 48e480e56aad
parent 57956 e0b8b019d2f5
child 58679 9c3209ff7550
permissions -rw-r--r--
8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base Summary: Minor coding style update of javadoc tag in any file in java.base Reviewed-by: bchristi, lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.io;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.security.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.util.Enumeration;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.util.Hashtable;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.util.StringTokenizer;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * This class is for Serializable permissions. A SerializablePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * contains a name (also referred to as a "target name") but
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * no actions list; you either have the named permission
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * or you don't.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * The target name is the name of the Serializable permission (see below).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * <P>
41230
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    43
 * The following table lists the standard {@code SerializablePermission} target names,
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * and for each provides a description of what the permission allows
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * and a discussion of the risks of granting code the permission.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 *
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    47
 * <table class="striped">
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    48
 * <caption style="display:none">Permission target name, what the permission allows, and associated risks</caption>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    49
 * <thead>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * <tr>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    51
 * <th scope="col">Permission Target Name</th>
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    52
 * <th scope="col">What the Permission Allows</th>
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    53
 * <th scope="col">Risks of Allowing this Permission</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * </tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    55
 * </thead>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    56
 * <tbody>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * <tr>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    59
 *   <th scope="row">enableSubclassImplementation</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 *   <td>Subclass implementation of ObjectOutputStream or ObjectInputStream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * to override the default serialization or deserialization, respectively,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 * of objects</td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 *   <td>Code can use this to serialize or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
 * deserialize classes in a purposefully malfeasant manner. For example,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * during serialization, malicious code can use this to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 * purposefully store confidential private field data in a way easily accessible
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 * to attackers. Or, during deserialization it could, for example, deserialize
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 * a class with all its private fields zeroed out.</td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 * </tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
 * <tr>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    72
 *   <th scope="row">enableSubstitution</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
 *   <td>Substitution of one object for another during
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
 * serialization or deserialization</td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
 *   <td>This is dangerous because malicious code
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
 * can replace the actual object with one which has incorrect or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
 * malignant data.</td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
 * </tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
 *
41230
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    80
 * <tr>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45124
diff changeset
    81
 *   <th scope="row">serialFilter</th>
41230
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    82
 *   <td>Setting a filter for ObjectInputStreams.</td>
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    83
 *   <td>Code could remove a configured filter and remove protections
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    84
 *       already established.</td>
0a8c1ba2b6fb 8155760: Implement Serialization Filtering
rriggs
parents: 25859
diff changeset
    85
 * </tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 41230
diff changeset
    86
 * </tbody>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
 * </table>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
 * @see java.security.BasicPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
 * @see java.security.Permission
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
 * @see java.security.Permissions
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
 * @see java.security.PermissionCollection
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
 * @see java.lang.SecurityManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
 * @author Joe Fialli
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
 * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
/* code was borrowed originally from java.lang.RuntimePermission. */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
public final class SerializablePermission extends BasicPermission {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
57956
e0b8b019d2f5 8229997: Apply java.io.Serial annotations in java.base
darcy
parents: 47216
diff changeset
   104
    @java.io.Serial
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
    private static final long serialVersionUID = 8537212141160296410L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * @serial
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
    private String actions;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * Creates a new SerializablePermission with the specified name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     * The name is the symbolic name of the SerializablePermission, such as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     * "enableSubstitution", etc.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
     * @param name the name of the SerializablePermission.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 57956
diff changeset
   119
     * @throws NullPointerException if {@code name} is {@code null}.
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 57956
diff changeset
   120
     * @throws IllegalArgumentException if {@code name} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
    public SerializablePermission(String name)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
        super(name);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * Creates a new SerializablePermission object with the specified name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     * The name is the symbolic name of the SerializablePermission, and the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     * actions String is currently unused and should be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
     * @param name the name of the SerializablePermission.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * @param actions currently unused and must be set to null
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     *
58288
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 57956
diff changeset
   135
     * @throws NullPointerException if {@code name} is {@code null}.
48e480e56aad 8231186: Replace html tag <code>foo</code> with javadoc tag {@code foo} in java.base
jboes
parents: 57956
diff changeset
   136
     * @throws IllegalArgumentException if {@code name} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
    public SerializablePermission(String name, String actions)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
        super(name, actions);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
}