001/*
002 * Copyright 2018 Paul Schaub.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.pgpainless.key.protection;
017
018import javax.annotation.Nullable;
019
020import org.bouncycastle.openpgp.PGPException;
021import org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor;
022import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor;
023
024public interface SecretKeyRingProtector {
025
026    /**
027     * Return a decryptor for the key of id {@code keyId}.
028     * This method returns null if the key is unprotected.
029     *
030     * @param keyId id of the key
031     * @return decryptor for the key
032     */
033    @Nullable PBESecretKeyDecryptor getDecryptor(Long keyId);
034
035    /**
036     * Return an encryptor for the key of id {@code keyId}.
037     * This method returns null if the key is unprotected.
038     *
039     * @param keyId id of the key
040     * @return encryptor for the key
041     * @throws PGPException if the encryptor cannot be created for some reason
042     */
043    @Nullable PBESecretKeyEncryptor getEncryptor(Long keyId) throws PGPException;
044
045}