aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Services/Interfaces/IAuthorizationService.cs
blob: 19742348481d62a9f072ebae8b0ddf936a00924d (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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using OpenSim.Framework;

namespace OpenSim.Services.Interfaces
{
    // Generic Authorization service used for authorizing principals in a particular region

    public interface IAuthorizationService
    {
        /// <summary>
        /// Check whether the user should be given access to the region.
        /// </summary>
        /// <remarks>
        /// We also supply user first name and last name for situations where the user does not have an account
        /// on the region (e.g. they're a visitor via Hypergrid).
        /// </remarks>
        /// <param name="userID"></param>
        /// <param name="firstName">/param>
        /// <param name="lastName"></param>
        /// <param name="regionID"></param>
        /// <param name="message"></param>
        /// <returns></returns>
        bool IsAuthorizedForRegion(
            string userID, string firstName, string lastName, string regionID, out string message, out bool isLocal);
    }

    public class AuthorizationRequest
    {
        private string m_userID;
        private string m_firstname;
        private string m_surname;
        private string m_email;
        private string m_regionName;
        private string m_regionID;

        public AuthorizationRequest()
        {
        }

        public AuthorizationRequest(string ID, string RegionID)
        {
            m_userID = ID;
            m_regionID = RegionID;
        }

        public AuthorizationRequest(
            string ID, string FirstName, string SurName, string Email, string RegionName, string RegionID)
        {
            m_userID = ID;
            m_firstname = FirstName;
            m_surname = SurName;
            m_email = Email;
            m_regionName = RegionName;
            m_regionID = RegionID;
        }

        public string ID
        {
            get { return m_userID; }
            set { m_userID = value; }
        }

        public string FirstName
        {
            get { return m_firstname; }
            set { m_firstname = value; }
        }

        public string SurName
        {
            get { return m_surname; }
            set { m_surname = value; }
        }

        public string Email
        {
            get { return m_email; }
            set { m_email = value; }
        }

        public string RegionName
        {
            get { return m_regionName; }
            set { m_regionName = value; }
        }

        public string RegionID
        {
            get { return m_regionID; }
            set { m_regionID = value; }
        }
    }

    public class AuthorizationResponse
    {
        private bool m_isAuthorized;
        private string m_message;

        public AuthorizationResponse()
        {
        }

        public AuthorizationResponse(bool isAuthorized, string message)
        {
            m_isAuthorized = isAuthorized;
            m_message = message;
        }

        public bool IsAuthorized
        {
            get { return m_isAuthorized; }
            set { m_isAuthorized = value; }
        }

        public string Message
        {
            get { return m_message; }
            set { m_message = value; }
        }
    }
}