/*
 * Copyright (c) 1997, 2019, 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
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.crypto.provider;

import java.lang.ref.Reference;
import java.security.MessageDigest;
import java.security.KeyRep;
import java.security.InvalidKeyException;
import javax.crypto.SecretKey;
import javax.crypto.spec.DESedeKeySpec;

import jdk.internal.ref.CleanerFactory;

This class represents a DES-EDE key.
Author:Jan Luehe
/** * This class represents a DES-EDE key. * * @author Jan Luehe * */
final class DESedeKey implements SecretKey { @java.io.Serial static final long serialVersionUID = 2463986565756745178L; private byte[] key;
Creates a DES-EDE key from a given key.
Params:
  • key – the given key
Throws:
/** * Creates a DES-EDE key from a given key. * * @param key the given key * * @exception InvalidKeyException if the given key has a wrong size */
DESedeKey(byte[] key) throws InvalidKeyException { this(key, 0); }
Uses the first 24 bytes in key, beginning at offset, as the DES-EDE key
Params:
  • key – the buffer with the DES-EDE key
  • offset – the offset in key, where the DES-EDE key starts
Throws:
/** * Uses the first 24 bytes in <code>key</code>, beginning at * <code>offset</code>, as the DES-EDE key * * @param key the buffer with the DES-EDE key * @param offset the offset in <code>key</code>, where the DES-EDE key * starts * * @exception InvalidKeyException if the given key has a wrong size */
DESedeKey(byte[] key, int offset) throws InvalidKeyException { if (key==null || ((key.length-offset)<DESedeKeySpec.DES_EDE_KEY_LEN)) { throw new InvalidKeyException("Wrong key size"); } this.key = new byte[DESedeKeySpec.DES_EDE_KEY_LEN]; System.arraycopy(key, offset, this.key, 0, DESedeKeySpec.DES_EDE_KEY_LEN); DESKeyGenerator.setParityBit(this.key, 0); DESKeyGenerator.setParityBit(this.key, 8); DESKeyGenerator.setParityBit(this.key, 16); // Use the cleaner to zero the key when no longer referenced final byte[] k = this.key; CleanerFactory.cleaner().register(this, () -> java.util.Arrays.fill(k, (byte)0x00)); } public byte[] getEncoded() { // The key is zeroized by finalize() // The reachability fence ensures finalize() isn't called early byte[] result = key.clone(); Reference.reachabilityFence(this); return result; } public String getAlgorithm() { return "DESede"; } public String getFormat() { return "RAW"; }
Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.
/** * Calculates a hash code value for the object. * Objects that are equal will also have the same hashcode. */
public int hashCode() { int retval = 0; for (int i = 1; i < this.key.length; i++) { retval += this.key[i] * i; } return(retval ^= "desede".hashCode()); } public boolean equals(Object obj) { if (this == obj) return true; if (!(obj instanceof SecretKey)) return false; String thatAlg = ((SecretKey)obj).getAlgorithm(); if (!(thatAlg.equalsIgnoreCase("DESede")) && !(thatAlg.equalsIgnoreCase("TripleDES"))) return false; byte[] thatKey = ((SecretKey)obj).getEncoded(); boolean ret = MessageDigest.isEqual(this.key, thatKey); java.util.Arrays.fill(thatKey, (byte)0x00); return ret; }
readObject is called to restore the state of this key from a stream.
/** * readObject is called to restore the state of this key from * a stream. */
@java.io.Serial private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException { s.defaultReadObject(); key = key.clone(); }
Replace the DESede key to be serialized.
Throws:
Returns:the standard KeyRep object to be serialized
/** * Replace the DESede key to be serialized. * * @return the standard KeyRep object to be serialized * * @throws java.io.ObjectStreamException if a new object representing * this DESede key could not be created */
@java.io.Serial private Object writeReplace() throws java.io.ObjectStreamException { return new KeyRep(KeyRep.Type.SECRET, getAlgorithm(), getFormat(), getEncoded()); } }