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.backup;
018
019import org.jivesoftware.smackx.ox.OpenPgpSecretKeyBackupPassphrase;
020
021public interface AskForBackupCodeCallback {
022
023    /**
024     * This callback is used to ask the user to provide a backup code.
025     * The backup code must follow the format described in XEP-0373 §5.3
026     *
027     * @see <a href="https://xmpp.org/extensions/xep-0373.html#backup-encryption">
028     *     XEP-0373 §5.4 Encrypting the Secret Key Backup</a>
029     *
030     * @return backup code provided by the user.
031     */
032    OpenPgpSecretKeyBackupPassphrase askForBackupCode();
033}