/*
    Myrtille: A native HTML4/5 Remote Desktop Protocol client.

    Copyright(c) 2014-2021 Cedric Coste
    Copyright(c) 2018 Paul Oliver (Olive Innovations)

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

namespace Myrtille.Services.Contracts
{
    public interface IMultifactorAuthenticationAdapter
    {
        /// <summary>
        /// Validate credentials using the adapter
        /// </summary>
        /// <param name="username">Username</param>
        /// <param name="password">Password</param>
        /// <returns></returns>
        bool Authenticate(string username, string password, string clientIP = null);

        /// <summary>
        /// This is the label to be displayed on the login screen
        /// </summary>
        string PromptLabel { get; }

        /// <summary>
        /// link to MFA provider page
        /// </summary>
        string ProviderURL { get; }
    }
}