aboutsummaryrefslogtreecommitdiff
path: root/Libs/VNLib.Plugins.Essentials.Sessions.VNCache/WebSessionIdFactoryImpl.cs
blob: 8dfda77d082e1175d0f371c7975e9319ef516211 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Essentials.Sessions.VNCache
* File: WebSessionIdFactoryImpl.cs 
*
* WebSessionIdFactoryImpl.cs is part of VNLib.Plugins.Essentials.Sessions.VNCache which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.Sessions.VNCache 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.VNCache 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.Diagnostics.CodeAnalysis;

using VNLib.Hashing;
using VNLib.Utils.Memory;
using VNLib.Utils.Extensions;
using VNLib.Plugins.Essentials.Extensions;
using VNLib.Net.Http;
using VNLib.Plugins.Essentials.Sessions.Runtime;

namespace VNLib.Plugins.Essentials.Sessions.VNCache
{
    /// <summary>
    /// <see cref="IWebSessionIdFactory"/> implementation, using 
    /// http cookies as session id storage
    /// </summary>
    internal sealed class WebSessionIdFactoryImpl : IWebSessionIdFactory
    {
        public TimeSpan ValidFor { get; }

        public string GenerateSessionId(IHttpEvent entity)
        {
            //Random hex hash
            string cookie = RandomHash.GetRandomBase32(_tokenSize);
          
            //Set the session id cookie
            entity.Server.SetCookie(SessionCookieName, cookie, ValidFor, secure: true, httpOnly: true);

            //return session-id value from cookie value
            return ComputeSessionIdFromCookie(cookie);
        }

        bool ISessionIdFactory.TryGetSessionId(IHttpEvent entity, [NotNullWhen(true)] out string? sessionId)
        {
            //Get authorization token and make sure its not too large to cause a buffer overflow
            if (entity.Server.GetCookie(SessionCookieName, out string? cookie) && (cookie.Length + SessionIdPrefix.Length) <= _bufferSize)
            {
                //Compute session id from token
                sessionId = ComputeSessionIdFromCookie(cookie);

                return true;
            }
            //Only add sessions for user-agents
            else if(entity.Server.IsBrowser())
            {
                //Get a new session id
                sessionId = GenerateSessionId(entity);

                return true;
            }
            else
            {
                sessionId = null;
                return false;
            }
        }

        private readonly string SessionCookieName;
        private readonly string SessionIdPrefix;
        private readonly int _bufferSize;
        private readonly int _tokenSize;

        /// <summary>
        /// Initialzies a new web session Id factory
        /// </summary>
        /// <param name="cookieSize">The size of the cookie in bytes</param>
        /// <param name="sessionCookieName">The name of the session cookie</param>
        /// <param name="sessionIdPrefix">The session-id internal prefix</param>
        /// <param name="validFor">The time the session cookie is valid for</param>
        public WebSessionIdFactoryImpl(uint cookieSize, string sessionCookieName, string sessionIdPrefix, TimeSpan validFor)
        {
            ValidFor = validFor;
            SessionCookieName = sessionCookieName;
            SessionIdPrefix = sessionIdPrefix;
            _tokenSize = (int)cookieSize;
            //Calc buffer size
            _bufferSize = Math.Max(32, ((int)cookieSize * 3) + sessionIdPrefix.Length);
        }
     

        private string ComputeSessionIdFromCookie(string sessionId)
        {
            //Buffer to copy data to
            using UnsafeMemoryHandle<char> buffer = Memory.UnsafeAlloc<char>(_bufferSize, true);

            //Writer to accumulate data
            ForwardOnlyWriter<char> writer = new(buffer.Span);

            //Append prefix and session id
            writer.Append(SessionIdPrefix);
            writer.Append(sessionId);

            //Compute base64 hash of token and 
            return ManagedHash.ComputeBase64Hash(writer.AsSpan(), HashAlg.SHA256);
        }
    }
}