/* * Copyright (c) Citrix Systems, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1) Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2) 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. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "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 * COPYRIGHT HOLDER OR 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 System.Collections.Generic; using System.Net; using CookComputing.XmlRpc; using Newtonsoft.Json; namespace XenAPI { public partial class Session : XenObject { public const int STANDARD_TIMEOUT = 24 * 60 * 60 * 1000; /// /// This string is used as the HTTP UserAgent for each request. /// public static string UserAgent = string.Format("XenAPI/{0}", Helper.APIVersionString(API_Version.LATEST)); /// /// If null, no proxy is used, otherwise this proxy is used for each request. /// public static IWebProxy Proxy = null; public API_Version APIVersion = API_Version.UNKNOWN; public object Tag; private List roles = new List(); /// /// Applies only to API 2.6 (ely) or 2.8 (inverness) and above. /// public Action XmlRpcToJsonRpcInvoker = SwitchToJsonRpcBackend; #region Constructors public Session(int timeout, string url) { InitializeXmlRpcProxy(url, timeout); } public Session(string url) : this(STANDARD_TIMEOUT, url) { } public Session(int timeout, string host, int port) : this(timeout, GetUrl(host, port)) { } public Session(string host, int port) : this(STANDARD_TIMEOUT, host, port) { } public Session(string url, string opaqueRef) : this(url) { opaque_ref = opaqueRef; SetupSessionDetails(); } /// /// Create a new Session instance, using the given instance and timeout. The connection details and Xen-API session handle will be /// copied from the given instance, but a new connection will be created. Use this if you want a duplicate connection to a host, /// for example when you need to cancel an operation that is blocking the primary connection. /// /// /// public Session(Session session, int timeout) { opaque_ref = session.opaque_ref; APIVersion = session.APIVersion; //in the following do not copy over the ConnectionGroupName if (session.JsonRpcClient != null && (APIVersion == API_Version.API_2_6 || APIVersion >= API_Version.API_2_8)) { JsonRpcClient = new JsonRpcClient(session.Url) { JsonRpcVersion = session.JsonRpcClient.JsonRpcVersion, Timeout = timeout, KeepAlive = session.JsonRpcClient.KeepAlive, UserAgent = session.JsonRpcClient.UserAgent, WebProxy = session.JsonRpcClient.WebProxy, ProtocolVersion = session.JsonRpcClient.ProtocolVersion, Expect100Continue = session.JsonRpcClient.Expect100Continue, AllowAutoRedirect = session.JsonRpcClient.AllowAutoRedirect, PreAuthenticate = session.JsonRpcClient.PreAuthenticate, Cookies = session.JsonRpcClient.Cookies }; } else if (session.XmlRpcProxy != null) { XmlRpcProxy = XmlRpcProxyGen.Create(); XmlRpcProxy.Url = session.Url; XmlRpcProxy.Timeout = timeout; XmlRpcProxy.NonStandard = session.XmlRpcProxy.NonStandard; XmlRpcProxy.UseIndentation = session.XmlRpcProxy.UseIndentation; XmlRpcProxy.UserAgent = session.XmlRpcProxy.UserAgent; XmlRpcProxy.KeepAlive = session.XmlRpcProxy.KeepAlive; XmlRpcProxy.Proxy = session.XmlRpcProxy.Proxy; } CopyADFromSession(session); } #endregion // Used after VDI.open_database public static Session get_record(Session session, string _session) { Session newSession = new Session(session.Url) {opaque_ref = _session}; newSession.SetAPIVersion(); if (newSession.XmlRpcToJsonRpcInvoker != null) newSession.XmlRpcToJsonRpcInvoker(newSession); return newSession; } private void InitializeXmlRpcProxy(string url, int timeout) { XmlRpcProxy = XmlRpcProxyGen.Create(); XmlRpcProxy.Url = url; XmlRpcProxy.NonStandard = XmlRpcNonStandard.All; XmlRpcProxy.Timeout = timeout; XmlRpcProxy.UseIndentation = false; XmlRpcProxy.UserAgent = UserAgent; XmlRpcProxy.KeepAlive = true; XmlRpcProxy.Proxy = Proxy; } private void SetupSessionDetails() { SetAPIVersion(); if (XmlRpcToJsonRpcInvoker != null) XmlRpcToJsonRpcInvoker(this); SetADDetails(); SetRbacPermissions(); } private void CopyADFromSession(Session session) { IsLocalSuperuser = session.IsLocalSuperuser; SessionSubject = session.SessionSubject; UserSid = session.UserSid; roles = session.Roles; Permissions = session.Permissions; } /// /// Applies only to API 1.6 (george) and above. /// private void SetADDetails() { if (APIVersion < API_Version.API_1_6) { IsLocalSuperuser = true; return; } IsLocalSuperuser = get_is_local_superuser(); if (IsLocalSuperuser) return; SessionSubject = get_subject(this, opaque_ref); UserSid = get_auth_user_sid(); // Cache the details of this user to avoid making server calls later // For example, some users get access to the pool through a group subject and will not be in the main cache UserDetails.UpdateDetails(UserSid, this); } /// /// Applies only to API 1.7 (midnight-ride) and above. /// Older versions have no RBAC, only AD. /// private void SetRbacPermissions() { if (APIVersion < API_Version.API_1_7) return; // allRoles will contain every role on the server, permissions contains the subset of those that are available to this session. Permissions = Session.get_rbac_permissions(this, opaque_ref); Dictionary, Role> allRoles = Role.get_all_records(this); // every Role object is either a single api call (a permission) or has subroles and contains permissions through its descendants. // We take out the parent Roles (VM-Admin etc.) into the Session.Roles field foreach (string s in Permissions) { foreach (XenRef xr in allRoles.Keys) { Role r = allRoles[xr]; if (r.subroles.Count > 0 && r.name_label == s) { r.opaque_ref = xr.opaque_ref; roles.Add(r); break; } } } } /// /// Retrieves the current users details from the UserDetails map. These values are only updated when a new session is created. /// public virtual UserDetails CurrentUserDetails { get { return UserSid == null ? null : UserDetails.Sid_To_UserDetails[UserSid]; } } public override void UpdateFrom(Session update) { throw new Exception("The method or operation is not implemented."); } public override string SaveChanges(Session session, string _serverOpaqueRef, Session serverObject) { throw new Exception("The method or operation is not implemented."); } #pragma warning disable 3005 [Obsolete("Use XmlRpcProxy instead.")] public Proxy proxy { get { return XmlRpcProxy; } private set { XmlRpcProxy = value; } } #pragma warning restore 3005 public Proxy XmlRpcProxy { get; private set; } public JsonRpcClient JsonRpcClient { get; private set; } [Obsolete("Use opaque_ref instead.")] public string uuid { get { return opaque_ref; } } public string Url { get { if (JsonRpcClient != null) return JsonRpcClient.Url; else return XmlRpcProxy.Url; } } public string ConnectionGroupName { get { if (JsonRpcClient != null) return JsonRpcClient.ConnectionGroupName; else return XmlRpcProxy.ConnectionGroupName; } set { if (JsonRpcClient != null) JsonRpcClient.ConnectionGroupName = value; else XmlRpcProxy.ConnectionGroupName = value; } } public ICredentials Credentials { get { if (JsonRpcClient != null) return JsonRpcClient.WebProxy == null ? null : JsonRpcClient.WebProxy.Credentials; if (XmlRpcProxy != null) return XmlRpcProxy.Proxy == null ? null : XmlRpcProxy.Proxy.Credentials; return null; } } /// /// Always true before API version 1.6. /// Filled in after successful session_login_with_password for 1.6 or newer connections /// public virtual bool IsLocalSuperuser { get; private set; } #pragma warning disable 3005 [Obsolete("Use SessionSubject instead.")] [JsonConverter(typeof(XenRefConverter))] public XenRef Subject { get { return SessionSubject; } private set { SessionSubject = value; } } #pragma warning restore 3005 /// /// The OpaqueRef for the Subject under whose authority the current user is logged in; /// may correspond to either a group or a user. /// Null if IsLocalSuperuser is true. /// [JsonConverter(typeof(XenRefConverter))] public XenRef SessionSubject { get; private set; } /// /// The Active Directory SID of the currently logged-in user. /// Null if IsLocalSuperuser is true. /// public string UserSid { get; private set; } /// /// All permissions associated with the session at the time of log in. This is the list xapi uses until the session is logged out; /// even if the permitted roles change on the server side, they don't apply until the next session. /// public string[] Permissions { get; private set; } /// /// All roles associated with the session at the time of log in. Do not rely on roles for determining what a user can do, /// instead use Permissions. This list should only be used for UI purposes. /// [JsonConverter(typeof(XenRefListConverter))] public List Roles { get { return roles; } } public void login_with_password(string username, string password) { if (JsonRpcClient != null) opaque_ref = JsonRpcClient.session_login_with_password(username, password); else opaque_ref = XmlRpcProxy.session_login_with_password(username, password).parse(); SetupSessionDetails(); } public void login_with_password(string username, string password, string version) { try { if (JsonRpcClient != null) opaque_ref = JsonRpcClient.session_login_with_password(username, password, version); else opaque_ref = XmlRpcProxy.session_login_with_password(username, password, version).parse(); SetupSessionDetails(); } catch (Failure exn) { if (exn.ErrorDescription[0] == Failure.MESSAGE_PARAMETER_COUNT_MISMATCH) { // Call the 1.1 version instead. login_with_password(username, password); } else { throw; } } } public void login_with_password(string username, string password, string version, string originator) { try { if (JsonRpcClient != null) opaque_ref = JsonRpcClient.session_login_with_password(username, password, version, originator); else opaque_ref = XmlRpcProxy.session_login_with_password(username, password, version, originator).parse(); SetupSessionDetails(); } catch (Failure exn) { if (exn.ErrorDescription[0] == Failure.MESSAGE_PARAMETER_COUNT_MISMATCH) { // Call the pre-2.0 version instead. login_with_password(username, password, version); } else { throw; } } } public void login_with_password(string username, string password, API_Version version) { login_with_password(username, password, Helper.APIVersionString(version)); } private void SetAPIVersion() { Dictionary, Pool> pools = Pool.get_all_records(this); foreach (Pool pool in pools.Values) { Host host = Host.get_record(this, pool.master); APIVersion = Helper.GetAPIVersion(host.API_version_major, host.API_version_minor); break; } } /// /// Applies only to API 2.6 (ely) or 2.8 (inverness) and above. /// private static void SwitchToJsonRpcBackend(Session session) { session.JsonRpcClient = null; bool isELy = session.APIVersion == API_Version.API_2_6; bool isInvernessOrAbove = session.APIVersion >= API_Version.API_2_8; if (isELy || isInvernessOrAbove) { session.JsonRpcClient = new JsonRpcClient(session.XmlRpcProxy.Url) { ConnectionGroupName = session.XmlRpcProxy.ConnectionGroupName, Timeout = session.XmlRpcProxy.Timeout, KeepAlive = session.XmlRpcProxy.KeepAlive, UserAgent = session.XmlRpcProxy.UserAgent, WebProxy = session.XmlRpcProxy.Proxy, ProtocolVersion = session.XmlRpcProxy.ProtocolVersion, Expect100Continue = session.XmlRpcProxy.Expect100Continue, AllowAutoRedirect = session.XmlRpcProxy.AllowAutoRedirect, PreAuthenticate = session.XmlRpcProxy.PreAuthenticate, Cookies = session.XmlRpcProxy.CookieContainer }; if (isInvernessOrAbove) session.JsonRpcClient.JsonRpcVersion = JsonRpcVersion.v2; session.XmlRpcProxy = null; } } public void slave_local_login_with_password(string username, string password) { if (JsonRpcClient != null) opaque_ref = JsonRpcClient.session_slave_local_login_with_password(username, password); else opaque_ref = XmlRpcProxy.session_slave_local_login_with_password(username, password).parse(); //assume the latest API APIVersion = API_Version.LATEST; } public void logout() { logout(this); } /// /// Log out of the given session2, using this session for the connection. /// /// The session to log out public void logout(Session session2) { logout(session2.opaque_ref); session2.opaque_ref = null; } /// /// Log out of the session with the given reference, using this session for the connection. /// /// The session to log out public void logout(string _self) { if (_self == null) return; if (JsonRpcClient != null) JsonRpcClient.session_logout(_self); else XmlRpcProxy.session_logout(_self).parse(); } public void local_logout() { local_logout(this); } public void local_logout(Session session2) { local_logout(session2.opaque_ref); session2.opaque_ref = null; } public void local_logout(string opaqueRef) { if (opaqueRef == null) return; if (JsonRpcClient != null) JsonRpcClient.session_local_logout(opaqueRef); else XmlRpcProxy.session_local_logout(opaqueRef).parse(); } public void change_password(string oldPassword, string newPassword) { change_password(this, oldPassword, newPassword); } /// /// Change the password on the given session2, using this session for the connection. /// /// The session to change /// /// public void change_password(Session session2, string oldPassword, string newPassword) { if (JsonRpcClient != null) JsonRpcClient.session_change_password(session2.opaque_ref, oldPassword, newPassword); else XmlRpcProxy.session_change_password(session2.opaque_ref, oldPassword, newPassword).parse(); } public string get_this_host() { return get_this_host(this, opaque_ref); } public static string get_this_host(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_this_host(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_this_host(session.opaque_ref, _self ?? "").parse(); } public string get_this_user() { return get_this_user(this, opaque_ref); } public static string get_this_user(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_this_user(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_this_user(session.opaque_ref, _self ?? "").parse(); } public bool get_is_local_superuser() { return get_is_local_superuser(this, opaque_ref); } public static bool get_is_local_superuser(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_is_local_superuser(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_is_local_superuser(session.opaque_ref, _self ?? "").parse(); } public static string[] get_rbac_permissions(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_rbac_permissions(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_rbac_permissions(session.opaque_ref, _self ?? "").parse(); } public DateTime get_last_active() { return get_last_active(this, opaque_ref); } public static DateTime get_last_active(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_last_active(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_last_active(session.opaque_ref, _self ?? "").parse(); } public bool get_pool() { return get_pool(this, opaque_ref); } public static bool get_pool(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_pool(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_pool(session.opaque_ref, _self ?? "").parse(); } public XenRef get_subject() { return get_subject(this, opaque_ref); } public static XenRef get_subject(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_subject(session.opaque_ref, _self ?? ""); else return new XenRef(session.XmlRpcProxy.session_get_subject(session.opaque_ref, _self ?? "").parse()); } public string get_auth_user_sid() { return get_auth_user_sid(this, opaque_ref); } public static string get_auth_user_sid(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_auth_user_sid(session.opaque_ref, _self ?? ""); else return session.XmlRpcProxy.session_get_auth_user_sid(session.opaque_ref, _self ?? "").parse(); } #region AD SID enumeration and bootout public string[] get_all_subject_identifiers() { return get_all_subject_identifiers(this); } public static string[] get_all_subject_identifiers(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_all_subject_identifiers(session.opaque_ref); else return session.XmlRpcProxy.session_get_all_subject_identifiers(session.opaque_ref).parse(); } public XenRef async_get_all_subject_identifiers() { return async_get_all_subject_identifiers(this); } public static XenRef async_get_all_subject_identifiers(Session session) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_session_get_all_subject_identifiers(session.opaque_ref); else return XenRef.Create(session.XmlRpcProxy.async_session_get_all_subject_identifiers(session.opaque_ref).parse()); } public string logout_subject_identifier(string subject_identifier) { return logout_subject_identifier(this, subject_identifier); } public static string logout_subject_identifier(Session session, string subject_identifier) { if (session.JsonRpcClient != null) { session.JsonRpcClient.session_logout_subject_identifier(session.opaque_ref, subject_identifier); return string.Empty; } else return session.XmlRpcProxy.session_logout_subject_identifier(session.opaque_ref, subject_identifier).parse(); } public XenRef async_logout_subject_identifier(string subject_identifier) { return async_logout_subject_identifier(this, subject_identifier); } public static XenRef async_logout_subject_identifier(Session session, string subject_identifier) { if (session.JsonRpcClient != null) return session.JsonRpcClient.async_session_logout_subject_identifier(session.opaque_ref, subject_identifier); else return XenRef.Create(session.XmlRpcProxy.async_session_logout_subject_identifier(session.opaque_ref, subject_identifier).parse()); } #endregion #region other_config stuff public Dictionary get_other_config() { return get_other_config(this, opaque_ref); } public static Dictionary get_other_config(Session session, string _self) { if (session.JsonRpcClient != null) return session.JsonRpcClient.session_get_other_config(session.opaque_ref, _self ?? ""); else return Maps.convert_from_proxy_string_string(session.XmlRpcProxy.session_get_other_config(session.opaque_ref, _self ?? "").parse()); } public void set_other_config(Dictionary _other_config) { set_other_config(this, opaque_ref, _other_config); } public static void set_other_config(Session session, string _self, Dictionary _other_config) { if (session.JsonRpcClient != null) session.JsonRpcClient.session_set_other_config(session.opaque_ref, _self ?? "", _other_config); else session.XmlRpcProxy.session_set_other_config(session.opaque_ref, _self ?? "", Maps.convert_to_proxy_string_string(_other_config)).parse(); } public void add_to_other_config(string _key, string _value) { add_to_other_config(this, opaque_ref, _key, _value); } public static void add_to_other_config(Session session, string _self, string _key, string _value) { if (session.JsonRpcClient != null) session.JsonRpcClient.session_add_to_other_config(session.opaque_ref, _self ?? "", _key ?? "", _value ?? ""); else session.XmlRpcProxy.session_add_to_other_config(session.opaque_ref, _self ?? "", _key ?? "", _value ?? "").parse(); } public void remove_from_other_config(string _key) { remove_from_other_config(this, opaque_ref, _key); } public static void remove_from_other_config(Session session, string _self, string _key) { if (session.JsonRpcClient != null) session.JsonRpcClient.session_remove_from_other_config(session.opaque_ref, _self ?? "", _key ?? ""); else session.XmlRpcProxy.session_remove_from_other_config(session.opaque_ref, _self ?? "", _key ?? "").parse(); } #endregion private static string GetUrl(string hostname, int port) { return string.Format("{0}://{1}:{2}", port == 8080 || port == 80 ? "http" : "https", hostname, port); } } }