archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 07:14:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8263105: security-libs doclint cleanup

Browse source 
Reviewed-by: iris, darcy, dfuchs, mullan
This commit is contained in:
Bradford Wetmore 2021-03-11 00:26:26 +00:00
parent 6971c23a3a
commit 32cbd193d9
35 changed files with 294 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/java.base/share/classes/java/security/AccessControlException.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -46,7 +46,9 @@ public class AccessControlException extends SecurityException {
@java.io.Serial
private static final long serialVersionUID = 5138225684096988535L;
// the permission that caused the exception to be thrown.
/**
* The permission that caused the exception to be thrown.
*/
private Permission perm;
/**

7
src/java.base/share/classes/java/security/AllPermission.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -161,7 +161,10 @@ final class AllPermissionCollection
@java.io.Serial
private static final long serialVersionUID = -4023755556366636806L;
private boolean all_allowed; // true if any all permissions have been added
/**
* True if any AllPermissions have been added.
*/
private boolean all_allowed;
/**
* Create an empty AllPermissions object.

18
src/java.base/share/classes/java/security/BasicPermission.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -260,6 +260,10 @@ public abstract class BasicPermission extends Permission
/**
* readObject is called to restore the state of the BasicPermission from
* a stream.
*
* @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream s)
@ -488,13 +492,17 @@ final class BasicPermissionCollection
new ObjectStreamField("permClass", Class.class),
};
/**
/*
* @serialData Default fields.
*/
/*
/**
* Writes the contents of the perms field out as a Hashtable for
* serialization compatibility with earlier releases. all_allowed
* and permClass unchanged.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(ObjectOutputStream out) throws IOException {
@ -517,6 +525,10 @@ final class BasicPermissionCollection
/**
* readObject is called to restore the state of the
* BasicPermissionCollection from a stream.
*
* @param in the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(java.io.ObjectInputStream in)

13
src/java.base/share/classes/java/security/CodeSigner.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -48,7 +48,7 @@ public final class CodeSigner implements Serializable {
*/
private CertPath signerCertPath;
/*
/**
* The signature timestamp.
*
* @serial
@ -165,7 +165,14 @@ public final class CodeSigner implements Serializable {
return sb.toString();
}
// Explicitly reset hash code value to -1
/**
* Restores the state of this object from the stream, and explicitly
* resets hash code value to -1.
*
* @param ois the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream ois)
throws IOException, ClassNotFoundException {

9
src/java.base/share/classes/java/security/CodeSource.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -522,6 +522,9 @@ public class CodeSource implements java.io.Serializable {
* followed by the certificate encoding itself which is written out as an
* array of bytes. Finally, if any code signers are present then the array
* of code signers is serialized and written out too.
*
* @param oos the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(java.io.ObjectOutputStream oos)
@ -557,6 +560,10 @@ public class CodeSource implements java.io.Serializable {
/**
* Restores this object from a stream (i.e., deserializes it).
*
* @param ois the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(java.io.ObjectInputStream ois)

20
src/java.base/share/classes/java/security/GuardedObject.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -25,6 +25,8 @@
package java.security;
import java.io.IOException;
/**
* A GuardedObject is an object that is used to protect access to
* another object.
@ -52,10 +54,17 @@ public class GuardedObject implements java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -5240450096227834308L;
/**
* The object we are guarding.
*/
@SuppressWarnings("serial") // Not statically typed as Serializable
private Object object; // the object we are guarding
private Object object;
/**
* The guard object.
*/
@SuppressWarnings("serial") // Not statically typed as Serializable
private Guard guard; // the guard
private Guard guard;
/**
* Constructs a GuardedObject using the specified object and guard.
@ -94,10 +103,13 @@ public class GuardedObject implements java.io.Serializable {
/**
* Writes this object out to a stream (i.e., serializes it).
* We check the guard if there is one.
*
* @param oos the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(java.io.ObjectOutputStream oos)
throws java.io.IOException
throws IOException
{
if (guard != null)
guard.checkGuard(object);

5
src/java.base/share/classes/java/security/KeyPair.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -44,7 +44,10 @@ public final class KeyPair implements java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -7565189502268009837L;
/** The private key. */
private PrivateKey privateKey;
/** The public key. */
private PublicKey publicKey;
/**

5
src/java.base/share/classes/java/security/Permission.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -68,6 +68,9 @@ public abstract class Permission implements Guard, java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -5636570222231596674L;
/**
* The permission name.
*/
private String name;
/**

8
src/java.base/share/classes/java/security/PermissionCollection.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -99,7 +99,11 @@ public abstract class PermissionCollection implements java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -6727011328946861783L;
// when set, add will throw an exception.
/**
* Whether this permission collection is read-only.
* <p>
* If set, the {@code add} method will throw an exception.
*/
private volatile boolean readOnly;
/**

14
src/java.base/share/classes/java/security/Permissions.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -577,11 +577,11 @@ implements Serializable
};
/**
* @serialData Default fields.
*/
/*
* Writes the contents of the permsMap field out as a Hashtable for
* serialization compatibility with earlier releases.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(ObjectOutputStream out) throws IOException {
@ -598,9 +598,13 @@ implements Serializable
out.writeFields();
}
/*
/**
* Reads in a Hashtable of Permission/Permission and saves them in the
* permsMap field.
*
* @param in the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream in) throws IOException,

20
src/java.base/share/classes/java/security/PrivilegedActionException.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -96,23 +96,28 @@ public class PrivilegedActionException extends Exception {
/**
* Serializable fields for UndeclaredThrowableException.
* The exception thrown by the privileged computation that resulted
* in this {@code PrivilegedActionException}.
*
* @serialField undeclaredThrowable Throwable
* @serialField exception Exception the thrown Exception
*/
@java.io.Serial
private static final ObjectStreamField[] serialPersistentFields = {
new ObjectStreamField("exception", Exception.class)
};
/*
/**
* Reconstitutes the PrivilegedActionException instance from a stream
* and initialize the cause properly when deserializing from an older
* version.
*
* The getException and getCause method returns the private "exception"
* <p>The getException and getCause method returns the private "exception"
* field in the older implementation and PrivilegedActionException::cause
* was set to null.
*
* @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException {
@ -123,9 +128,12 @@ public class PrivilegedActionException extends Exception {
}
}
/*
/**
* To maintain compatibility with older implementation, write a serial
* "exception" field with the cause as the value.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(ObjectOutputStream out) throws IOException {

4
src/java.base/share/classes/java/security/Provider.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -860,6 +860,8 @@ public abstract class Provider extends Properties {
* is, then its double value will be used to populate both fields.
*
* @param in the {@code ObjectInputStream} to read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
* @serial
*/
@java.io.Serial

6
src/java.base/share/classes/java/security/SecureRandom.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -178,8 +178,8 @@ public class SecureRandom extends java.util.Random {
*/
private final boolean threadSafe;
/*
* The algorithm name of null if unknown.
/**
* The algorithm name or {@code null} if unknown.
*
* @serial
* @since 1.5

30
src/java.base/share/classes/java/security/SignedObject.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -118,17 +118,23 @@ import java.io.*;
public final class SignedObject implements Serializable {
@java.io.Serial
@Serial
private static final long serialVersionUID = 720502720485447167L;
/*
/**
* The original content is "deep copied" in its serialized format
* and stored in a byte array. The signature field is also in the
* form of byte array.
* and stored in a byte array.
*/
private byte[] content;
/**
* The signature field is stored as a byte array.
*/
private byte[] signature;
/**
* The algorithm used to sign the object.
*/
private String thealgorithm;
/**
@ -250,11 +256,15 @@ public final class SignedObject implements Serializable {
/**
* readObject is called to restore the state of the SignedObject from
* a stream.
*
* @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(java.io.ObjectInputStream s)
throws java.io.IOException, ClassNotFoundException {
java.io.ObjectInputStream.GetField fields = s.readFields();
@Serial
private void readObject(ObjectInputStream s)
throws IOException, ClassNotFoundException {
ObjectInputStream.GetField fields = s.readFields();
content = ((byte[])fields.get("content", null)).clone();
signature = ((byte[])fields.get("signature", null)).clone();
thealgorithm = (String)fields.get("thealgorithm", null);

11
src/java.base/share/classes/java/security/Timestamp.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -155,7 +155,14 @@ public final class Timestamp implements Serializable {
return sb.toString();
}
// Explicitly reset hash code value to -1
/**
* Restores the state of this object from the stream, and explicitly
* resets hash code value to -1.
*
* @param ois the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream ois)
throws IOException, ClassNotFoundException {

9
src/java.base/share/classes/java/security/UnresolvedPermission.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -521,6 +521,9 @@ implements java.io.Serializable
* {@code int} specifying the length of the certificate encoding,
* followed by the certificate encoding itself which is written out as an
* array of bytes.
*
* @param oos the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(java.io.ObjectOutputStream oos)
@ -550,6 +553,10 @@ implements java.io.Serializable
/**
* Restores this object from a stream (i.e., deserializes it).
*
* @param ois the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(java.io.ObjectInputStream ois)

14
src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -155,12 +155,12 @@ implements java.io.Serializable
};
/**
* @serialData Default field.
*/
/*
* Writes the contents of the perms field out as a Hashtable
* in which the values are Vectors for
* serialization compatibility with earlier releases.
*
* @param out the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(ObjectOutputStream out) throws IOException {
@ -187,9 +187,13 @@ implements java.io.Serializable
out.writeFields();
}
/*
/**
* Reads in a Hashtable in which the values are Vectors of
* UnresolvedPermissions and saves them in the perms field.
*
* @param in the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream in) throws IOException,

5
src/java.base/share/classes/java/security/cert/CertPath.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -122,7 +122,8 @@ public abstract class CertPath implements Serializable {
@java.io.Serial
private static final long serialVersionUID = 6068470306649138683L;
private String type; // the type of certificates in this chain
/** The type of certificates in this chain. */
private String type;
/**
* Creates a {@code CertPath} of the specified type.

9
src/java.base/share/classes/java/security/cert/CertPathValidatorException.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -229,6 +229,13 @@ public class CertPathValidatorException extends GeneralSecurityException {
return this.reason;
}
/**
* Restores the state of this object from the stream.
*
* @param stream the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream stream)
throws ClassNotFoundException, IOException {

9
src/java.base/share/classes/java/security/cert/Certificate.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -65,10 +65,10 @@ public abstract class Certificate implements java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -3585440601605666277L;
// the certificate type
/** The certificate type. */
private final String type;
/** Cache the hash code for the certiticate */
/** The hash code for the certificate. */
private int hash = -1; // Default to -1
/**
@ -244,7 +244,10 @@ public abstract class Certificate implements java.io.Serializable {
@java.io.Serial
private static final long serialVersionUID = -8563758940495660020L;
/** The standard name of the certificate type. */
private String type;
/** The certificate data. */
private byte[] data;
/**

9
src/java.base/share/classes/java/security/cert/CertificateRevokedException.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -192,6 +192,9 @@ public class CertificateRevokedException extends CertificateException {
* the following data is emitted: the OID String (Object), the criticality
* flag (boolean), the length of the encoded extension value byte array
* (int), and the encoded extension value bytes.
*
* @param oos the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private void writeObject(ObjectOutputStream oos) throws IOException {
@ -219,6 +222,10 @@ public class CertificateRevokedException extends CertificateException {
/**
* Deserialize the {@code CertificateRevokedException} instance.
*
* @param ois the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(ObjectInputStream ois)

7
src/java.base/share/classes/java/util/Random.java
View file

@ -1179,6 +1179,10 @@ public class Random implements java.io.Serializable {
/**
* Reconstitute the {@code Random} instance from a stream (that is,
* deserialize it).
*
* @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs
* @throws ClassNotFoundException if a serialized class cannot be loaded
*/
@java.io.Serial
private void readObject(java.io.ObjectInputStream s)
@ -1199,6 +1203,9 @@ public class Random implements java.io.Serializable {
/**
* Save the {@code Random} instance to a stream.
*
* @param s the {@code ObjectOutputStream} to which data is written
* @throws IOException if an I/O error occurs
*/
@java.io.Serial
private synchronized void writeObject(ObjectOutputStream s)