1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage javax.net.ssl; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.net.Socket; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.Principal; 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.PrivateKey; 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.cert.X509Certificate; 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * A Key Manager for X509 certificate-based key pairs. 27adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic interface X509KeyManager extends KeyManager { 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Chooses an alias for the client side of an SSL connection to authenticate 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * it with the specified public key type and certificate issuers. 33f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyType 35adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of public key algorithm names. 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param issuers 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of certificate issuers, or {@code null} if any issuer 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * will do. 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param socket 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the socket for the connection, or {@code null} if 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias selected does not depend on a specific socket. 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the alias name of a matching key or {@code null} if there are no 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * matches. 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String chooseClientAlias(String[] keyType, Principal[] issuers, 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Socket socket); 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Chooses an alias for the server side of an SSL connection to authenticate 50adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * it with the specified public key type and certificate issuers. 51f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyType 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of public key algorithm type names. 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param issuers 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of certificate issuers, or {@code null} if any issuer 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * will do. 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param socket 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the socket for the connection, or {@code null} if 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias selected does not depend on a specific socket. 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the alias name of a matching key or {@code null} if there are no 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * matches. 62adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String chooseServerAlias(String keyType, Principal[] issuers, 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Socket socket); 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the certificate chain for the specified alias. 68f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 69adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias to get the certificate chain for. 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the certificate chain for the specified alias, or {@code null} if 72adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias cannot be found. 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 74adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public X509Certificate[] getCertificateChain(String alias); 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 77adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the client aliases for the specified public key type and list of 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * certificate issuers. 79f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyType 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the public key algorithm type name. 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param issuers 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of certificate issuers, or {@code null} if any issuer 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * will do. 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the client aliases for the specified public key type, or 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null} if there are no matching aliases. 87adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String[] getClientAliases(String keyType, Principal[] issuers); 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the server aliases for the specified public key type and list of 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * certificate issuers. 93f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 94adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param keyType 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the public key algorithm type name. 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param issuers 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the list of certificate issuers, or {@code null} if any issuer 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * will do. 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the client aliases for the specified public key type, or 100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code null} if there are no matching aliases. 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public String[] getServerAliases(String keyType, Principal[] issuers); 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 104adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the private key for the specified alias. 106f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson * 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param alias 108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the alias to get the private key for. 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the private key for the specified alias, or {@code null} if the 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * alias cannot be found. 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project public PrivateKey getPrivateKey(String alias); 113f921579f87fa63204b4a4bef39ed27e7835aec45Jesse Wilson} 114