1 /* 2 * Copyright (c) 2020, 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 package java.security.interfaces; 26 27 import java.security.PrivateKey; 28 import java.util.Optional; 29 30 /** 31 * An interface for an elliptic curve private key as defined by 32 * <a href="https://tools.ietf.org/html/rfc8032">RFC 8032: Edwards-Curve 33 * Digital Signature Algorithm (EdDSA)</a>. These keys are distinct from the 34 * keys represented by {@code ECPrivateKey}, and they are intended for use 35 * with algorithms based on RFC 8032 such as the EdDSA {@code Signature} 36 * algorithm. 37 * <p> 38 * An Edwards-Curve private key is a bit string. This interface only supports bit 39 * string lengths that are a multiple of 8, and the key is represented using 40 * a byte array. 41 * 42 * @since 15 43 */ 44 public interface EdECPrivateKey extends EdECKey, PrivateKey { 45 46 /** 47 * Get a copy of the byte array representing the private key. This method 48 * may return an empty {@code Optional} if the implementation is not 49 * willing to produce the private key value. 50 * 51 * @return an {@code Optional} containing the private key byte array. 52 * If the key is not available, then an empty {@code Optional}. 53 */ getBytes()54 Optional<byte[]> getBytes(); 55 } 56