/*

 * Copyright (c) 2015, 2018, 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 sun.security.ssl;

import java.io.IOException;

import java.nio.ByteBuffer;

import java.security.CryptoPrimitive;

import java.security.InvalidAlgorithmParameterException;

import java.security.InvalidKeyException;

import java.security.Key;

import java.security.KeyFactory;

import java.security.NoSuchAlgorithmException;

import java.security.PrivateKey;

import java.security.PublicKey;

import java.security.Signature;

import java.security.SignatureException;

import java.security.interfaces.ECPublicKey;

import java.security.spec.ECParameterSpec;

import java.security.spec.ECPoint;

import java.security.spec.ECPublicKeySpec;

import java.security.spec.InvalidKeySpecException;

import java.text.MessageFormat;

import java.util.EnumSet;

import java.util.Locale;

import sun.security.ssl.ECDHKeyExchange.ECDHECredentials;

import sun.security.ssl.ECDHKeyExchange.ECDHEPossession;

import sun.security.ssl.SSLHandshake.HandshakeMessage;

import sun.security.ssl.SupportedGroupsExtension.NamedGroup;

import sun.security.ssl.SupportedGroupsExtension.SupportedGroups;

import sun.security.ssl.X509Authentication.X509Credentials;

import sun.security.ssl.X509Authentication.X509Possession;

import sun.security.util.HexDumpEncoder;

/**

 * Pack of the ServerKeyExchange handshake message.

 */

final class ECDHServerKeyExchange {

    static final SSLConsumer ecdheHandshakeConsumer =

            new ECDHServerKeyExchangeConsumer();

    static final HandshakeProducer ecdheHandshakeProducer =

            new ECDHServerKeyExchangeProducer();

    /**

     * The ECDH ServerKeyExchange handshake message.

     */

    private static final

            class ECDHServerKeyExchangeMessage extends HandshakeMessage {

        private static final byte CURVE_NAMED_CURVE = (byte)0x03;

        // id of the named curve

        private final NamedGroup namedGroup;

        // encoded public point

        private final byte[] publicPoint;

        // signature bytes, or null if anonymous

        private final byte[] paramsSignature;

        // public key object encapsulated in this message

        private final ECPublicKey publicKey;

        private final boolean useExplicitSigAlgorithm;

        // the signature algorithm used by this ServerKeyExchange message

        private final SignatureScheme signatureScheme;

        ECDHServerKeyExchangeMessage(

                HandshakeContext handshakeContext) throws IOException {

            super(handshakeContext);

            // This happens in server side only.

            ServerHandshakeContext shc =

                    (ServerHandshakeContext)handshakeContext;

            ECDHEPossession ecdhePossession = null;

            X509Possession x509Possession = null;

            for (SSLPossession possession : shc.handshakePossessions) {

                if (possession instanceof ECDHEPossession) {

                    ecdhePossession = (ECDHEPossession)possession;

                    if (x509Possession != null) {

                        break;

                    }

                } else if (possession instanceof X509Possession) {

                    x509Possession = (X509Possession)possession;

                    if (ecdhePossession != null) {

                        break;

                    }

                }

            }

            if (ecdhePossession == null) {

                // unlikely

                    "No ECDHE credentials negotiated for server key exchange");

            }

            publicKey = ecdhePossession.publicKey;

            ECParameterSpec params = publicKey.getParams();

            ECPoint point = publicKey.getW();

            publicPoint = JsseJce.encodePoint(point, params.getCurve());

            this.namedGroup = NamedGroup.valueOf(params);

            if ((namedGroup == null) || (namedGroup.oid == null) ) {

                // unlikely

                    "Unnamed EC parameter spec: " + params);

            }

            if (x509Possession == null) {

                // anonymous, no authentication, no signature

                paramsSignature = null;

                signatureScheme = null;

                useExplicitSigAlgorithm = false;

            } else {

                useExplicitSigAlgorithm =

                        shc.negotiatedProtocol.useTLS12PlusSpec();

                Signature signer = null;

                if (useExplicitSigAlgorithm) {

                    signatureScheme = SignatureScheme.getPreferableAlgorithm(

                            shc.peerRequestedSignatureSchemes,

                            x509Possession.popPrivateKey,

                            shc.negotiatedProtocol);

                    if (signatureScheme == null) {

                        // Unlikely, the credentials generator should have

                        // selected the preferable signature algorithm properly.

                                "No preferred signature algorithm for " +

                                x509Possession.popPrivateKey.getAlgorithm() +

                                "  key");

                    }

                    try {

                        signer = signatureScheme.getSignature(

                                x509Possession.popPrivateKey);

                    } catch (NoSuchAlgorithmException | InvalidKeyException |

                            InvalidAlgorithmParameterException nsae) {

                            "Unsupported signature algorithm: " +

                            signatureScheme.name, nsae);

                    }

                } else {

                    signatureScheme = null;

                    try {

                        signer = getSignature(

                                x509Possession.popPrivateKey.getAlgorithm(),

                                x509Possession.popPrivateKey);

                    } catch (NoSuchAlgorithmException | InvalidKeyException e) {

                            "Unsupported signature algorithm: " +

                            x509Possession.popPrivateKey.getAlgorithm(), e);

                    }

                }

                byte[] signature = null;

                try {

                    updateSignature(signer, shc.clientHelloRandom.randomBytes,

                            shc.serverHelloRandom.randomBytes,

                            namedGroup.id, publicPoint);

                    signature = signer.sign();

                } catch (SignatureException ex) {

                        "Failed to sign ecdhe parameters: " +

                        x509Possession.popPrivateKey.getAlgorithm(), ex);

                }

                paramsSignature = signature;

            }

        }

        ECDHServerKeyExchangeMessage(HandshakeContext handshakeContext,

                ByteBuffer m) throws IOException {

            super(handshakeContext);

            // This happens in client side only.

            ClientHandshakeContext chc =

                    (ClientHandshakeContext)handshakeContext;

            byte curveType = (byte)Record.getInt8(m);

            if (curveType != CURVE_NAMED_CURVE) {

                // Unlikely as only the named curves should be negotiated.

                    "Unsupported ECCurveType: " + curveType);

            }

            int namedGroupId = Record.getInt16(m);

            this.namedGroup = NamedGroup.valueOf(namedGroupId);

            if (namedGroup == null) {

                    "Unknown named group ID: " + namedGroupId);

            }

            if (!SupportedGroups.isSupported(namedGroup)) {

                    "Unsupported named group: " + namedGroup);

            }

            if (namedGroup.oid == null) {

                    "Unknown named EC curve: " + namedGroup);

            }

            ECParameterSpec parameters =

                    JsseJce.getECParameterSpec(namedGroup.oid);

            if (parameters == null) {

                    "No supported EC parameter: " + namedGroup);

            }

            publicPoint = Record.getBytes8(m);

            if (publicPoint.length == 0) {

                    "Insufficient ECPoint data: " + namedGroup);

            }

            ECPublicKey ecPublicKey = null;

            try {

                ECPoint point =

                        JsseJce.decodePoint(publicPoint, parameters.getCurve());

                KeyFactory factory = JsseJce.getKeyFactory("EC");

                ecPublicKey = (ECPublicKey)factory.generatePublic(

                    new ECPublicKeySpec(point, parameters));

            } catch (NoSuchAlgorithmException |

                    InvalidKeySpecException | IOException ex) {

                    "Invalid ECPoint: " + namedGroup, ex);

            }

            publicKey = ecPublicKey;

            X509Credentials x509Credentials = null;

            for (SSLCredentials cd : chc.handshakeCredentials) {

                if (cd instanceof X509Credentials) {

                    x509Credentials = (X509Credentials)cd;

                    break;

                }

            }

            if (x509Credentials == null) {

                // anonymous, no authentication, no signature

                if (m.hasRemaining()) {

                        "Invalid DH ServerKeyExchange: unknown extra data");

                }

                this.signatureScheme = null;

                this.paramsSignature = null;

                this.useExplicitSigAlgorithm = false;

                return;

            }

            this.useExplicitSigAlgorithm =

                    chc.negotiatedProtocol.useTLS12PlusSpec();

            if (useExplicitSigAlgorithm) {

                int ssid = Record.getInt16(m);

                signatureScheme = SignatureScheme.valueOf(ssid);

                if (signatureScheme == null) {

                        "Invalid signature algorithm (" + ssid +

                        ") used in ECDH ServerKeyExchange handshake message");

                }

                if (!chc.localSupportedSignAlgs.contains(signatureScheme)) {

                        "Unsupported signature algorithm (" +

                        signatureScheme.name +

                        ") used in ECDH ServerKeyExchange handshake message");

                }

            } else {

                signatureScheme = null;

            }

            // read and verify the signature

            paramsSignature = Record.getBytes16(m);

            Signature signer;

            if (useExplicitSigAlgorithm) {

                try {

                    signer = signatureScheme.getSignature(

                            x509Credentials.popPublicKey);

                } catch (NoSuchAlgorithmException | InvalidKeyException |

                        InvalidAlgorithmParameterException nsae) {

                        "Unsupported signature algorithm: " +

                        signatureScheme.name, nsae);

                }

            } else {

                try {

                    signer = getSignature(

                            x509Credentials.popPublicKey.getAlgorithm(),

                            x509Credentials.popPublicKey);

                } catch (NoSuchAlgorithmException | InvalidKeyException e) {

                        "Unsupported signature algorithm: " +

                        x509Credentials.popPublicKey.getAlgorithm(), e);

                }

            }

            try {

                updateSignature(signer,

                        chc.clientHelloRandom.randomBytes,

                        chc.serverHelloRandom.randomBytes,

                        namedGroup.id, publicPoint);

                if (!signer.verify(paramsSignature)) {

                        "Invalid ECDH ServerKeyExchange signature");

                }

            } catch (SignatureException ex) {

                        "Cannot verify ECDH ServerKeyExchange signature", ex);

            }

        }

        @Override

        public SSLHandshake handshakeType() {

            return SSLHandshake.SERVER_KEY_EXCHANGE;

        }

        @Override

        public int messageLength() {

            int sigLen = 0;

            if (paramsSignature != null) {

                sigLen = 2 + paramsSignature.length;

                if (useExplicitSigAlgorithm) {

                    sigLen += SignatureScheme.sizeInRecord();

                }

            }

            return 4 + publicPoint.length + sigLen;

        }

        @Override

        public void send(HandshakeOutStream hos) throws IOException {

            hos.putInt8(CURVE_NAMED_CURVE);

            hos.putInt16(namedGroup.id);

            hos.putBytes8(publicPoint);

            if (paramsSignature != null) {

                if (useExplicitSigAlgorithm) {

                    hos.putInt16(signatureScheme.id);

                }

                hos.putBytes16(paramsSignature);

            }

        }

        @Override

        public String toString() {

            if (useExplicitSigAlgorithm) {

                MessageFormat messageFormat = new MessageFormat(

                    "\"ECDH ServerKeyExchange\": '{'\n" +

                    "  \"parameters\": '{'\n" +

                    "    \"named group\": \"{0}\"\n" +

                    "    \"ecdh public\": '{'\n" +

                    "{1}\n" +

                    "    '}',\n" +

                    "  '}',\n" +

                    "  \"digital signature\":  '{'\n" +

                    "    \"signature algorithm\": \"{2}\"\n" +

                    "    \"signature\": '{'\n" +

                    "{3}\n" +

                    "    '}',\n" +

                    "  '}'\n" +

                    "'}'",

                    Locale.ENGLISH);

                HexDumpEncoder hexEncoder = new HexDumpEncoder();

                Object[] messageFields = {

                    namedGroup.name,

                    Utilities.indent(

                            hexEncoder.encodeBuffer(publicPoint), "      "),

                    signatureScheme.name,

                    Utilities.indent(

                            hexEncoder.encodeBuffer(paramsSignature), "      ")

                };

                return messageFormat.format(messageFields);

            } else if (paramsSignature != null) {

                MessageFormat messageFormat = new MessageFormat(

                    "\"ECDH ServerKeyExchange\": '{'\n" +

                    "  \"parameters\":  '{'\n" +

                    "    \"named group\": \"{0}\"\n" +

                    "    \"ecdh public\": '{'\n" +

                    "{1}\n" +

                    "    '}',\n" +

                    "  '}',\n" +

                    "  \"signature\": '{'\n" +

                    "{2}\n" +

                    "  '}'\n" +

                    "'}'",

                    Locale.ENGLISH);

                HexDumpEncoder hexEncoder = new HexDumpEncoder();

                Object[] messageFields = {

                    namedGroup.name,

                    Utilities.indent(

                            hexEncoder.encodeBuffer(publicPoint), "      "),

                    Utilities.indent(

                            hexEncoder.encodeBuffer(paramsSignature), "    ")

                };

                return messageFormat.format(messageFields);

            } else {    // anonymous

                MessageFormat messageFormat = new MessageFormat(

                    "\"ECDH ServerKeyExchange\": '{'\n" +

                    "  \"parameters\":  '{'\n" +

                    "    \"named group\": \"{0}\"\n" +

                    "    \"ecdh public\": '{'\n" +

                    "{1}\n" +

                    "    '}',\n" +

                    "  '}'\n" +

                    "'}'",

                    Locale.ENGLISH);

                HexDumpEncoder hexEncoder = new HexDumpEncoder();

                Object[] messageFields = {

                    namedGroup.name,

                    Utilities.indent(

                            hexEncoder.encodeBuffer(publicPoint), "      "),

                };

                return messageFormat.format(messageFields);

            }

        }

        private static Signature getSignature(String keyAlgorithm,

                Key key) throws NoSuchAlgorithmException, InvalidKeyException {

            Signature signer = null;

            switch (keyAlgorithm) {

                case "EC":

                    signer = JsseJce.getSignature(JsseJce.SIGNATURE_ECDSA);

                    break;

                case "RSA":

                    signer = RSASignature.getInstance();

                    break;

                default:

                    throw new NoSuchAlgorithmException(

                        "neither an RSA or a EC key : " + keyAlgorithm);

            }

            if (signer != null) {

                if (key instanceof PublicKey) {

                    signer.initVerify((PublicKey)(key));

                } else {

                    signer.initSign((PrivateKey)key);

                }

            }

            return signer;

        }

        private static void updateSignature(Signature sig,

                byte[] clntNonce, byte[] svrNonce, int namedGroupId,

                byte[] publicPoint) throws SignatureException {

            sig.update(clntNonce);

            sig.update(svrNonce);

            sig.update(CURVE_NAMED_CURVE);

            sig.update((byte)((namedGroupId >> 8) & 0xFF));

            sig.update((byte)(namedGroupId & 0xFF));

            sig.update((byte)publicPoint.length);

            sig.update(publicPoint);

        }

    }

    /**

     * The ECDH "ServerKeyExchange" handshake message producer.

     */

    private static final

            class ECDHServerKeyExchangeProducer implements HandshakeProducer {

        // Prevent instantiation of this class.

        private ECDHServerKeyExchangeProducer() {

            // blank

        }

        @Override

        public byte[] produce(ConnectionContext context,

                HandshakeMessage message) throws IOException {

            // The producing happens in server side only.

            ServerHandshakeContext shc = (ServerHandshakeContext)context;

            ECDHServerKeyExchangeMessage skem =

                    new ECDHServerKeyExchangeMessage(shc);

            if (SSLLogger.isOn && SSLLogger.isOn("ssl,handshake")) {

                SSLLogger.fine(

                    "Produced ECDH ServerKeyExchange handshake message", skem);

            }

            // Output the handshake message.

            skem.write(shc.handshakeOutput);

            shc.handshakeOutput.flush();

            // The handshake message has been delivered.

            return null;

        }

    }

    /**

     * The ECDH "ServerKeyExchange" handshake message consumer.

     */

    private static final

            class ECDHServerKeyExchangeConsumer implements SSLConsumer {

        // Prevent instantiation of this class.

        private ECDHServerKeyExchangeConsumer() {

            // blank

        }