001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.security.twofactor;
029
030/**
031 * The data needed to set up two-factor authentication for a user.
032 */
033public class CmsSecondFactorSetupInfo {
034
035    /** A data URL with the QR code to scan with authenticator apps. */
036    private String m_qrCodeImageUrl;
037
038    /** The shared secret. */
039    private String m_secret;
040
041    /**
042     * Creates a new instance.
043     *
044     * @param secret the shared secret
045     * @param qrCodeImageUrl the QR code data URL
046     */
047    public CmsSecondFactorSetupInfo(String secret, String qrCodeImageUrl) {
048
049        m_secret = secret;
050        m_qrCodeImageUrl = qrCodeImageUrl;
051    }
052
053    /**
054     * Gets the data URL with the QR code image that the user should scan.
055     *
056     * @return the QR code data URL
057     */
058    public String getQrCodeImageUrl() {
059
060        return m_qrCodeImageUrl;
061    }
062
063    /**
064     * Gets the shared secret in text form.
065     *
066     * @return the shared secret
067     */
068    public String getSecret() {
069
070        return m_secret;
071    }
072
073}