151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.security; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Set; 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This interface specifies constraints for cryptographic algorithms, 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * keys (key sizes), and other algorithm parameters. 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@code AlgorithmConstraints} objects are immutable. An implementation 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this interface should not provide methods that can change the state 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of an instance once it has been created. 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Note that {@code AlgorithmConstraints} can be used to represent the 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * restrictions described by the security properties 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@code jdk.certpath.disabledAlgorithms} and 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@code jdk.tls.disabledAlgorithms}, or could be used by a 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * concrete {@code PKIXCertPathChecker} to check whether a specified 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * certificate in the certification path contains the required algorithm 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * constraints. 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see javax.net.ssl.SSLParameters#getAlgorithmConstraints 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see javax.net.ssl.SSLParameters#setAlgorithmConstraints(AlgorithmConstraints) 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.7 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic interface AlgorithmConstraints { 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines whether an algorithm is granted permission for the 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified cryptographic primitives. 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param primitives a set of cryptographic primitives 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param algorithm the algorithm name 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param parameters the algorithm parameters, or null if no additional 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * parameters 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return true if the algorithm is permitted and can be used for all 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of the specified cryptographic primitives 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if primitives or algorithm is null 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or empty 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean permits(Set<CryptoPrimitive> primitives, 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String algorithm, AlgorithmParameters parameters); 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines whether a key is granted permission for the specified 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cryptographic primitives. 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method is usually used to check key size and key usage. 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param primitives a set of cryptographic primitives 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return true if the key can be used for all of the specified 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cryptographic primitives 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if primitives is null or empty, 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the key is null 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean permits(Set<CryptoPrimitive> primitives, Key key); 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines whether an algorithm and the corresponding key are granted 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * permission for the specified cryptographic primitives. 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param primitives a set of cryptographic primitives 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param algorithm the algorithm name 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param parameters the algorithm parameters, or null if no additional 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * parameters 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return true if the key and the algorithm can be used for all of the 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified cryptographic primitives 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if primitives or algorithm is null 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or empty, or the key is null 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean permits(Set<CryptoPrimitive> primitives, 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String algorithm, Key key, AlgorithmParameters parameters); 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 109