OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
LocalAuthorizationServiceConnector.cs
Go to the documentation of this file.
1 /*
2  * Copyright (c) Contributors, http://opensimulator.org/
3  * See CONTRIBUTORS.TXT for a full list of copyright holders.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of the OpenSimulator Project nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 using log4net;
29 using Mono.Addins;
30 using Nini.Config;
31 using System;
32 using System.Collections.Generic;
33 using System.Reflection;
34 using OpenSim.Framework;
35 using OpenSim.Server.Base;
36 using OpenSim.Region.Framework.Interfaces;
37 using OpenSim.Region.Framework.Scenes;
38 using OpenSim.Services.Interfaces;
39 using OpenMetaverse;
40 
41 namespace OpenSim.Region.CoreModules.ServiceConnectorsOut.Authorization
42 {
43  [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "LocalAuthorizationServicesConnector")]
45  {
46  private static readonly ILog m_log =
47  LogManager.GetLogger(
48  MethodBase.GetCurrentMethod().DeclaringType);
49 
50  private IAuthorizationService m_AuthorizationService;
51  private Scene m_Scene;
52  private IConfig m_AuthorizationConfig;
53 
54  private bool m_Enabled = false;
55 
56  public Type ReplaceableInterface
57  {
58  get { return null; }
59  }
60 
61  public string Name
62  {
63  get { return "LocalAuthorizationServicesConnector"; }
64  }
65 
66  public void Initialise(IConfigSource source)
67  {
68  m_log.Info("[AUTHORIZATION CONNECTOR]: Initialise");
69 
70  IConfig moduleConfig = source.Configs["Modules"];
71  if (moduleConfig != null)
72  {
73  string name = moduleConfig.GetString("AuthorizationServices", string.Empty);
74  if (name == Name)
75  {
76  m_Enabled = true;
77  m_AuthorizationConfig = source.Configs["AuthorizationService"];
78  m_log.Info("[AUTHORIZATION CONNECTOR]: Local authorization connector enabled");
79  }
80  }
81  }
82 
83  public void PostInitialise()
84  {
85  }
86 
87  public void Close()
88  {
89  }
90 
91  public void AddRegion(Scene scene)
92  {
93  if (!m_Enabled)
94  return;
95 
96  scene.RegisterModuleInterface<IAuthorizationService>(this);
97  m_Scene = scene;
98  }
99 
100  public void RemoveRegion(Scene scene)
101  {
102  }
103 
104  public void RegionLoaded(Scene scene)
105  {
106  if (!m_Enabled)
107  return;
108 
109  m_AuthorizationService = new AuthorizationService(m_AuthorizationConfig, m_Scene);
110 
111  m_log.InfoFormat(
112  "[AUTHORIZATION CONNECTOR]: Enabled local authorization for region {0}",
113  scene.RegionInfo.RegionName);
114  }
115 
117  string userID, string firstName, string lastName, string regionID, out string message)
118  {
119  message = "";
120  if (!m_Enabled)
121  return true;
122 
123  return m_AuthorizationService.IsAuthorizedForRegion(userID, firstName, lastName, regionID, out message);
124  }
125  }
126 }
bool IsAuthorizedForRegion(string userID, string firstName, string lastName, string regionID, out string message)
Check whether the user should be given access to the region.
void RemoveRegion(Scene scene)
This is called whenever a Scene is removed. For shared modules, this can happen several times...
void AddRegion(Scene scene)
This is called whenever a Scene is added. For shared modules, this can happen several times...
void Initialise(IConfigSource source)
This is called to initialize the region module. For shared modules, this is called exactly once...
void RegionLoaded(Scene scene)
This will be called once for every scene loaded. In a shared module this will be multiple times in on...
void Close()
This is the inverse to Initialise. After a Close(), this instance won't be usable anymore...