001/**
002 *
003 * Copyright 2018 Paul Schaub.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.ox.callback;
018
019import org.pgpainless.key.OpenPgpV4Fingerprint;
020import org.pgpainless.util.Passphrase;
021
022public interface SecretKeyPassphraseCallback {
023
024    /**
025     * This method gets called in case a passphrase is needed for a secret key.
026     *
027     * @param fingerprint fingerprint of the key
028     * @return passphrase for the key
029     */
030    Passphrase onPassphraseNeeded(OpenPgpV4Fingerprint fingerprint);
031}