/*
* Copyright (c) 2022 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Essentials.Sessions.OAuth
* File: IOauthSessionIdFactory.cs
*
* IOauthSessionIdFactory.cs is part of VNLib.Plugins.Essentials.Sessions.OAuth which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.Sessions.OAuth is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials.Sessions.OAuth is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Diagnostics.CodeAnalysis;
using VNLib.Net.Http;
using VNLib.Plugins.Essentials.Oauth.Applications;
using VNLib.Plugins.Sessions.Cache.Client;
namespace VNLib.Plugins.Sessions.OAuth
{
internal interface IOauthSessionIdFactory
{
///
/// The maxium number of tokens allowed to be created per OAuth application
///
int MaxTokensPerApp { get; }
///
/// Allows for custom configuration of the newly created session and
/// the its attached to
///
/// The newly created session
/// The application associated with the session
/// The http event that generated the new session
void InitNewSession(RemoteSession session, UserApplication app, IHttpEvent entity);
///
/// The time a session is valid for
///
TimeSpan SessionValidFor { get; }
///
/// Called when the session provider wishes to generate a new session
/// and required credential information to generate the new session
///
/// The information genreated for the news ession
TokenAndSessionIdResult GenerateTokensAndId();
///
/// The type of token this session provider generates
///
string TokenType { get; }
///
/// Attempts to recover a session id from
///
/// The entity to get the session-id for
/// The found ID for the session if accepted
/// True if a session id was found or set for the session
bool TryGetSessionId(IHttpEvent entity, [NotNullWhen(true)] out string? sessionId);
}
}