Create Firewall Rule support with a simple Resource Provider implementation

Implementation of the resource provider APIs in order to support Create Firewall Rule. Provides definition for a ResourceProvider and Authentication service. The ResourceProvider supports firewall rules for now, and since authentication is routed through that method it will call into the auth service to set up the current account to be used.

Additional notes:
- Fixed deserialization by adding an Accept header. This shouldn't be necessary, but for some reason the firewall rule defaults to XML without this
- Use generic server list and parse the ID to get the resource group, avoiding a large number of extra calls for each RG
- Errors now include error message from the API
This commit is contained in:
Kevin Cunnane
2017-10-09 15:45:33 -07:00
committed by GitHub
parent fecf56bce2
commit 7acc668c04
49 changed files with 1844 additions and 556 deletions

View File

@@ -0,0 +1,20 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
namespace Microsoft.SqlTools.ResourceProvider.Core
{
internal class AccountOptionsHelper
{
/// <summary>
/// The name of the IsMsAccount option
/// </summary>
internal const string IsMsAccount = "IsMsAccount";
/// <summary>
/// The name of the Tenants option
/// </summary>
internal const string Tenants = "Tentants";
}
}

View File

@@ -0,0 +1,31 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
using Microsoft.SqlTools.ResourceProvider.Core.Contracts;
namespace Microsoft.SqlTools.ResourceProvider.Core.Authentication
{
/// <summary>
/// Contains an account and related token information usable for login purposes
/// </summary>
public class AccountTokenWrapper
{
public AccountTokenWrapper(Account account, Dictionary<string, AccountSecurityToken> securityTokenMappings)
{
Account = account;
SecurityTokenMappings = securityTokenMappings;
}
/// <summary>
/// Account defining a connected service login
/// </summary>
public Account Account { get; private set; }
/// <summary>
/// Token mappings from tentant ID to their access token
/// </summary>
public Dictionary<string, AccountSecurityToken> SecurityTokenMappings { get; private set; }
}
}

View File

@@ -0,0 +1,29 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
namespace Microsoft.SqlTools.ResourceProvider.Core.Authentication
{
/// <summary>
/// User account authentication information to be used by <see cref="IAccountManager" />
/// </summary>
public interface IAzureTenant
{
/// <summary>
/// The unique Id for the tenant
/// </summary>
string TenantId
{
get;
}
/// <summary>
/// Display ID
/// </summary>
string AccountDisplayableId
{
get;
}
}
}

View File

@@ -3,13 +3,14 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using System;
using System.Collections.Generic;
namespace Microsoft.SqlTools.ResourceProvider.Core.Authentication
{
/// <summary>
/// Contains information about an Azure user account
/// </summary>
public interface IAzureUserAccount : IEquatable<IAzureUserAccount>, IUserAccount
public interface IAzureUserAccount : IEquatable<IAzureUserAccount>, IUserAccount
{
/// <summary>
/// User Account Display Info
@@ -20,11 +21,19 @@ namespace Microsoft.SqlTools.ResourceProvider.Core.Authentication
}
/// <summary>
/// Tenant Id
/// Primary Tenant Id
/// </summary>
string TenantId
{
get;
}
}
/// <summary>
/// All tenant IDs
/// </summary>
IList<IAzureTenant> AllTenants
{
get;
}
}
}

View File

@@ -0,0 +1,47 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Collections.Generic;
using System.Composition;
using System.Threading.Tasks;
using Microsoft.SqlTools.Extensibility;
using Microsoft.SqlTools.Hosting;
using Microsoft.SqlTools.Hosting.Protocol;
using Microsoft.SqlTools.ResourceProvider.Core;
using Microsoft.SqlTools.ResourceProvider.Core.Authentication;
using Microsoft.SqlTools.ResourceProvider.Core.Contracts;
using Microsoft.SqlTools.ResourceProvider.Core.Extensibility;
using Microsoft.SqlTools.ResourceProvider.Core.Firewall;
using Microsoft.SqlTools.Utility;
namespace Microsoft.SqlTools.ResourceProvider.Core
{
[Export(typeof(IHostedService))]
public class AuthenticationService : HostedService<AuthenticationService>, IComposableService
{
/// <summary>
/// The default constructor is required for MEF-based composable services
/// </summary>
public AuthenticationService()
{
}
public override void InitializeService(IProtocolEndpoint serviceHost)
{
Logger.Write(LogLevel.Verbose, "AuthenticationService initialized");
}
public async Task<IUserAccount> SetCurrentAccountAsync(Account account, Dictionary<string, AccountSecurityToken> securityTokenMappings)
{
var authManager = ServiceProvider.GetService<IAzureAuthenticationManager>();
// Ideally in the future, would have a factory to create the user account and tenant info without knowing
// which implementation is which. For expediency, will directly define these in this instance.
return await authManager.SetCurrentAccountAsync(new AccountTokenWrapper(account, securityTokenMappings));
}
}
}

View File

@@ -0,0 +1,119 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
namespace Microsoft.SqlTools.ResourceProvider.Core.Contracts
{
/// <summary>
/// An object, usable in <see cref="CreateFirewallRuleRequest"/>s and other messages
/// </summary>
public class Account
{
/// <summary>
/// The key that identifies the account
/// </summary>
public AccountKey Key { get; set; }
/// <summary>
/// Display information for the account
/// </summary>
public AccountDisplayInfo DisplayInfo { get; set; }
/// <summary>
/// Customizable properties, which will include the access token or similar authentication support
/// </summary>
public AccountProperties Properties { get; set; }
/// <summary>
/// Indicates if the account needs refreshing
/// </summary>
public bool IsStale { get; set; }
}
/// <summary>
/// Azure-specific properties. Note that ideally with would reuse GeneralRequestDetails but
/// this isn't feasible right now as that is specific to having an Options property to hang it off
/// </summary>
public class AccountProperties
{
/// <summary>
/// Is this a Microsoft account, such as live.com, or not?
/// </summary>
internal bool IsMsAccount
{
get;
set;
}
/// <summary>
/// Tenants for each object
/// </summary>
public IEnumerable<Tenant> Tenants
{
get;
set;
}
}
/// <summary>
/// Represents a key that identifies an account.
/// </summary>
public class AccountKey
{
/// <summary>
/// Identifier of the provider
/// </summary>
public string ProviderId { get; set; }
// Note: ignoring ProviderArgs as it's not relevant
/// <summary>
/// Identifier for the account, unique to the provider
/// </summary>
public string AccountId { get; set; }
}
/// <summary>
/// Represents display information for an account.
/// </summary>
public class AccountDisplayInfo
{
/// <summary>
/// A display name that offers context for the account, such as "Contoso".
/// </summary>
public string ContextualDisplayName { get; set; }
// Note: ignoring ContextualLogo as it's not needed
/// <summary>
/// A display name that identifies the account, such as "user@contoso.com".
/// </summary
public string DisplayName { get; set; }
}
/// <summary>
/// Represents a tenant (an Azure Active Directory instance) to which a user has access
/// </summary>
public class Tenant
{
/// <summary>
/// Globally unique identifier of the tenant
/// </summary>
public string Id { get; set; }
/// <summary>
/// Display name of the tenant
/// </summary>
public string DisplayName { get; set; }
/// <summary>
/// Identifier of the user in the tenant
/// </summary>
public string UserId { get; set; }
}
}

View File

@@ -0,0 +1,35 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
namespace Microsoft.SqlTools.ResourceProvider.Core.Contracts
{
/// <summary>
/// Contains key information about a Token used to log in to a resource provider
/// </summary>
public class AccountSecurityToken
{
/// <summary>
/// Expiration time for the token
/// </summary>
public string ExpiresOn { get; set; }
/// <summary>
/// URI defining the root for resource lookup
/// </summary>
public string Resource { get; set; }
/// <summary>
/// The actual token
/// </summary>
public string Token { get; set; }
/// <summary>
/// The type of token being sent - for example "Bearer" for most resource queries
/// </summary>
public string TokenType { get; set; }
}
}

View File

@@ -0,0 +1,102 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
namespace Microsoft.SqlTools.ResourceProvider.Core.Contracts
{
/// <summary>
/// A request to open up a firewall rule
/// </summary>
public class CreateFirewallRuleRequest
{
public static readonly
RequestType<CreateFirewallRuleParams, CreateFirewallRuleResponse> Type =
RequestType<CreateFirewallRuleParams, CreateFirewallRuleResponse>.Create("resource/createFirewallRule");
}
/// <summary>
/// A FirewallRule object, usable in <see cref="CreateFirewallRuleRequest"/>s and other messages
/// </summary>
public class CreateFirewallRuleParams
{
/// <summary>
/// Account information to use in connecting to Azure
/// </summary>
public Account Account { get; set; }
/// <summary>
/// Per-tenant token mappings. Ideally would be set independently of this call, but for
/// now this allows us to get the tokens necessary to find a server and open a firewall rule
/// </summary>
public Dictionary<string,AccountSecurityToken> SecurityTokenMappings { get; set; }
/// <summary>
/// Fully qualified name of the server to create a new firewall rule on
/// </summary>
public string ServerName { get; set; }
/// <summary>
/// Start of the IP address range
/// </summary>
public string StartIpAddress { get; set; }
/// <summary>
/// End of the IP address range
/// </summary>
public string EndIpAddress { get; set; }
}
public class CreateFirewallRuleResponse
{
public bool Result { get; set; }
public string ErrorMessage { get; set; }
}
public class CanHandleFirewallRuleRequest
{
public static readonly
RequestType<HandleFirewallRuleParams, HandleFirewallRuleResponse> Type =
RequestType<HandleFirewallRuleParams, HandleFirewallRuleResponse>.Create("resource/handleFirewallRule");
}
public class HandleFirewallRuleParams
{
/// <summary>
/// The error code used to defined the error type
/// </summary>
public int ErrorCode { get; set; }
/// <summary>
/// The error message from which to parse the IP address
/// </summary>
public string ErrorMessage { get; set; }
/// <summary>
/// The connection type, for example MSSQL
/// </summary>
public string ConnectionTypeId { get; set; }
}
/// <summary>
/// Response to the check for Firewall rule support given an error message
/// </summary>
public class HandleFirewallRuleResponse
{
/// <summary>
/// Can this be handled?
/// </summary>
public bool Result { get; set; }
/// <summary>
/// If not, why?
/// </summary>
public string ErrorMessage { get; set; }
/// <summary>
/// If it can be handled, is there a default IP address to send back so users
/// can tell what their blocked IP is?
/// </summary>
public string IpAddress { get; set; }
}
}

View File

@@ -5,7 +5,7 @@
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.SqlTools.ResourceProvider.Core.Authentication;
using Microsoft.SqlTools.ResourceProvider.Core.FirewallRule;
using Microsoft.SqlTools.ResourceProvider.Core.Firewall;
using Microsoft.SqlTools.ResourceProvider.Core.Extensibility;
namespace Microsoft.SqlTools.ResourceProvider.Core
@@ -49,5 +49,13 @@ namespace Microsoft.SqlTools.ResourceProvider.Core
);
Task<IAzureResourceManagementSession> CreateSessionAsync(IAzureUserAccountSubscriptionContext subscriptionContext);
/// <summary>
/// Gets all subscription contexts under a specific user account. Queries all tenants for the account and uses these to log in
/// and retrieve subscription information as needed
/// <param name="userAccount">Account whose subscriptions should be queried</param>
/// </summary>
Task<IEnumerable<IAzureUserAccountSubscriptionContext>> GetSubscriptionContextsAsync(IAzureUserAccount userAccount);
}
}

View File

@@ -7,7 +7,7 @@ using System.Data.SqlClient;
using System.Net;
using System.Text.RegularExpressions;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
internal interface IFirewallErrorParser
{

View File

@@ -4,7 +4,7 @@
using System.Net;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
/// <summary>
/// The response that's created by firewall rule parser

View File

@@ -6,7 +6,7 @@ using System;
using System.Net;
using System.Runtime.Serialization;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
/// <summary>
/// Exception used by firewall service to indicate when firewall rule operation fails

View File

@@ -6,7 +6,7 @@ using System;
using System.Globalization;
using System.Net;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
/// <summary>
/// Includes all the information needed to create a firewall rule

View File

@@ -4,7 +4,7 @@
using Microsoft.SqlTools.ResourceProvider.Core.Authentication;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
/// <summary>
/// Includes azure resource and subscription needed to create firewall rule

View File

@@ -2,7 +2,7 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
/// <summary>
/// The response that's created when the firewall rule creation request is complete

View File

@@ -9,7 +9,7 @@ using System.Net;
using System.Threading.Tasks;
using Microsoft.SqlTools.ResourceProvider.Core.Authentication;
namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
namespace Microsoft.SqlTools.ResourceProvider.Core.Firewall
{
public interface IFirewallRuleService
@@ -89,7 +89,7 @@ namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
}
catch (Exception ex)
{
throw new FirewallRuleException(SR.FirewallRuleCreationFailed, ex);
throw new FirewallRuleException(string.Format(CultureInfo.CurrentCulture, SR.FirewallRuleCreationFailedWithError, ex.Message), ex);
}
}
@@ -135,7 +135,7 @@ namespace Microsoft.SqlTools.ResourceProvider.Core.FirewallRule
}
catch (Exception ex)
{
throw new FirewallRuleException(SR.FirewallRuleCreationFailed, ex);
throw new FirewallRuleException(string.Format(CultureInfo.CurrentCulture, SR.FirewallRuleCreationFailedWithError, ex.Message), ex);
}
return new FirewallRuleResponse()

View File

@@ -1,104 +1,120 @@
// WARNING:
// This file was generated by the Microsoft DataWarehouse String Resource Tool 1.37.0.0
// from information in sr.strings
// DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
//
namespace Microsoft.SqlTools.ResourceProvider.Core
{
using System;
using System.Reflection;
using System.Resources;
using System.Globalization;
// WARNING:
// This file was generated by the Microsoft DataWarehouse String Resource Tool 1.37.0.0
// from information in sr.strings
// DO NOT MODIFY THIS FILE'S CONTENTS, THEY WILL BE OVERWRITTEN
//
namespace Microsoft.SqlTools.ResourceProvider.Core
{
using System;
using System.Reflection;
using System.Resources;
using System.Globalization;
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
internal class SR
{
protected SR()
{ }
public static CultureInfo Culture
{
get
{
return Keys.Culture;
}
set
{
Keys.Culture = value;
}
}
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
internal class SR
{
protected SR()
{ }
public static CultureInfo Culture
{
get
{
return Keys.Culture;
}
set
{
Keys.Culture = value;
}
public static string AzureServerNotFound
{
get
{
return Keys.GetString(Keys.AzureServerNotFound);
}
}
public static string AzureServerNotFound
{
get
{
return Keys.GetString(Keys.AzureServerNotFound);
}
public static string AzureSubscriptionFailedErrorMessage
{
get
{
return Keys.GetString(Keys.AzureSubscriptionFailedErrorMessage);
}
}
public static string AzureSubscriptionFailedErrorMessage
{
get
{
return Keys.GetString(Keys.AzureSubscriptionFailedErrorMessage);
}
public static string DatabaseDiscoveryFailedErrorMessage
{
get
{
return Keys.GetString(Keys.DatabaseDiscoveryFailedErrorMessage);
}
}
public static string DatabaseDiscoveryFailedErrorMessage
{
get
{
return Keys.GetString(Keys.DatabaseDiscoveryFailedErrorMessage);
}
public static string FirewallRuleAccessForbidden
{
get
{
return Keys.GetString(Keys.FirewallRuleAccessForbidden);
}
}
public static string FirewallRuleAccessForbidden
{
get
{
return Keys.GetString(Keys.FirewallRuleAccessForbidden);
}
public static string FirewallRuleCreationFailed
{
get
{
return Keys.GetString(Keys.FirewallRuleCreationFailed);
}
}
public static string FirewallRuleCreationFailed
{
get
{
return Keys.GetString(Keys.FirewallRuleCreationFailed);
}
public static string FirewallRuleCreationFailedWithError
{
get
{
return Keys.GetString(Keys.FirewallRuleCreationFailedWithError);
}
}
public static string InvalidIpAddress
{
get
{
return Keys.GetString(Keys.InvalidIpAddress);
}
public static string InvalidIpAddress
{
get
{
return Keys.GetString(Keys.InvalidIpAddress);
}
}
public static string InvalidServerTypeErrorMessage
{
get
{
return Keys.GetString(Keys.InvalidServerTypeErrorMessage);
}
public static string InvalidServerTypeErrorMessage
{
get
{
return Keys.GetString(Keys.InvalidServerTypeErrorMessage);
}
}
public static string LoadingExportableFailedGeneralErrorMessage
{
get
{
return Keys.GetString(Keys.LoadingExportableFailedGeneralErrorMessage);
}
public static string LoadingExportableFailedGeneralErrorMessage
{
get
{
return Keys.GetString(Keys.LoadingExportableFailedGeneralErrorMessage);
}
}
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
public class Keys
{
static ResourceManager resourceManager = new ResourceManager("Microsoft.SqlTools.ResourceProvider.Core.Localization.SR", typeof(SR).GetTypeInfo().Assembly);
static CultureInfo _culture = null;
public static string FirewallRuleUnsupportedConnectionType
{
get
{
return Keys.GetString(Keys.FirewallRuleUnsupportedConnectionType);
}
}
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
public class Keys
{
static ResourceManager resourceManager = new ResourceManager("Microsoft.SqlTools.ResourceProvider.Core.Localization.SR", typeof(SR).GetTypeInfo().Assembly);
static CultureInfo _culture = null;
public const string AzureServerNotFound = "AzureServerNotFound";
@@ -116,6 +132,9 @@ namespace Microsoft.SqlTools.ResourceProvider.Core
public const string FirewallRuleCreationFailed = "FirewallRuleCreationFailed";
public const string FirewallRuleCreationFailedWithError = "FirewallRuleCreationFailedWithError";
public const string InvalidIpAddress = "InvalidIpAddress";
@@ -125,25 +144,28 @@ namespace Microsoft.SqlTools.ResourceProvider.Core
public const string LoadingExportableFailedGeneralErrorMessage = "LoadingExportableFailedGeneralErrorMessage";
private Keys()
{ }
public const string FirewallRuleUnsupportedConnectionType = "FirewallRuleUnsupportedConnectionType";
public static CultureInfo Culture
{
get
{
return _culture;
}
set
{
_culture = value;
}
}
public static string GetString(string key)
{
return resourceManager.GetString(key, _culture);
}
private Keys()
{ }
public static CultureInfo Culture
{
get
{
return _culture;
}
set
{
_culture = value;
}
}
public static string GetString(string key)
{
return resourceManager.GetString(key, _culture);
}
}
}

View File

@@ -1,152 +1,160 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype=">text/microsoft-resx</resheader>
<resheader name="version=">2.0</resheader>
<resheader name="reader=">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer=">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1="><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing=">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64=">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64=">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata=">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true=">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded=">
<xsd:element name="metadata=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly=">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="AzureServerNotFound" xml:space="preserve">
<value>The server you specified {0} does not exist in any subscription in {1}. Either you have signed in with an incorrect account or your server was removed from subscription(s) in this account. Please check your account and try again.</value>
<comment></comment>
<?xml version="1.0" encoding="utf-8"?>
<root>
<!--
Microsoft ResX Schema
Version 2.0
The primary goals of this format is to allow a simple XML format
that is mostly human readable. The generation and parsing of the
various data types are done through the TypeConverter classes
associated with the data types.
Example:
... ado.net/XML headers & schema ...
<resheader name="resmimetype=">text/microsoft-resx</resheader>
<resheader name="version=">2.0</resheader>
<resheader name="reader=">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
<resheader name="writer=">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
<data name="Name1="><value>this is my long string</value><comment>this is a comment</comment></data>
<data name="Color1" type="System.Drawing.Color, System.Drawing=">Blue</data>
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64=">
<value>[base64 mime encoded serialized .NET Framework object]</value>
</data>
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64=">
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
<comment>This is a comment</comment>
</data>
There are any number of "resheader" rows that contain simple
name/value pairs.
Each data row contains a name, and value. The row also contains a
type or mimetype. Type corresponds to a .NET class that support
text/value conversion through the TypeConverter architecture.
Classes that don't support this are serialized and stored with the
mimetype set.
The mimetype is used for serialized objects, and tells the
ResXResourceReader how to depersist the object. This is currently not
extensible. For a given mimetype the value must be set accordingly:
Note - application/x-microsoft.net.object.binary.base64 is the format
that the ResXResourceWriter will generate, however the reader can
read any of the formats listed below.
mimetype: application/x-microsoft.net.object.binary.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.soap.base64
value : The object must be serialized with
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
: and then encoded with base64 encoding.
mimetype: application/x-microsoft.net.object.bytearray.base64
value : The object must be serialized into a byte array
: using a System.ComponentModel.TypeConverter
: and then encoded with base64 encoding.
-->
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata=">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true=">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded=">
<xsd:element name="metadata=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly=">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader=">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="AzureServerNotFound" xml:space="preserve">
<value>The server you specified {0} does not exist in any subscription in {1}. Either you have signed in with an incorrect account or your server was removed from subscription(s) in this account. Please check your account and try again.</value>
<comment></comment>
</data>
<data name="AzureSubscriptionFailedErrorMessage" xml:space="preserve">
<value>An error occurred while getting Azure subscriptions</value>
<comment></comment>
<data name="AzureSubscriptionFailedErrorMessage" xml:space="preserve">
<value>An error occurred while getting Azure subscriptions</value>
<comment></comment>
</data>
<data name="DatabaseDiscoveryFailedErrorMessage" xml:space="preserve">
<value>An error occurred while getting databases from servers of type {0} from {1}</value>
<comment></comment>
<data name="DatabaseDiscoveryFailedErrorMessage" xml:space="preserve">
<value>An error occurred while getting databases from servers of type {0} from {1}</value>
<comment></comment>
</data>
<data name="FirewallRuleAccessForbidden" xml:space="preserve">
<value>{0} does not have permission to change the server firewall rule. Try again with a different account that is an Owner or Contributor of the Azure subscription or the server.</value>
<comment></comment>
<data name="FirewallRuleAccessForbidden" xml:space="preserve">
<value>{0} does not have permission to change the server firewall rule. Try again with a different account that is an Owner or Contributor of the Azure subscription or the server.</value>
<comment></comment>
</data>
<data name="FirewallRuleCreationFailed" xml:space="preserve">
<value>An error occurred while creating a new firewall rule.</value>
<comment></comment>
<data name="FirewallRuleCreationFailed" xml:space="preserve">
<value>An error occurred while creating a new firewall rule.</value>
<comment></comment>
</data>
<data name="InvalidIpAddress" xml:space="preserve">
<value>Invalid IP address</value>
<comment></comment>
<data name="FirewallRuleCreationFailedWithError" xml:space="preserve">
<value>An error occurred while creating a new firewall rule: '{0}'</value>
<comment></comment>
</data>
<data name="InvalidServerTypeErrorMessage" xml:space="preserve">
<value>Server Type is invalid.</value>
<comment></comment>
<data name="InvalidIpAddress" xml:space="preserve">
<value>Invalid IP address</value>
<comment></comment>
</data>
<data name="LoadingExportableFailedGeneralErrorMessage" xml:space="preserve">
<value>A required dll cannot be loaded. Please repair your application.</value>
<comment></comment>
<data name="InvalidServerTypeErrorMessage" xml:space="preserve">
<value>Server Type is invalid.</value>
<comment></comment>
</data>
<data name="LoadingExportableFailedGeneralErrorMessage" xml:space="preserve">
<value>A required dll cannot be loaded. Please repair your application.</value>
<comment></comment>
</data>
<data name="FirewallRuleUnsupportedConnectionType" xml:space="preserve">
<value>Cannot open a firewall rule for the specified connection type</value>
<comment></comment>
</data>
</root>

View File

@@ -27,6 +27,8 @@ AzureSubscriptionFailedErrorMessage = An error occurred while getting Azure subs
DatabaseDiscoveryFailedErrorMessage = An error occurred while getting databases from servers of type {0} from {1}
FirewallRuleAccessForbidden = {0} does not have permission to change the server firewall rule. Try again with a different account that is an Owner or Contributor of the Azure subscription or the server.
FirewallRuleCreationFailed = An error occurred while creating a new firewall rule.
FirewallRuleCreationFailedWithError = An error occurred while creating a new firewall rule: '{0}'
InvalidIpAddress = Invalid IP address
InvalidServerTypeErrorMessage = Server Type is invalid.
LoadingExportableFailedGeneralErrorMessage = A required dll cannot be loaded. Please repair your application.
FirewallRuleUnsupportedConnectionType = Cannot open a firewall rule for the specified connection type

View File

@@ -42,6 +42,16 @@
<target state="new">An error occurred while creating a new firewall rule.</target>
<note></note>
</trans-unit>
<trans-unit id="FirewallRuleUnsupportedConnectionType">
<source>Cannot open a firewall rule for the specified connection type</source>
<target state="new">Cannot open a firewall rule for the specified connection type</target>
<note></note>
</trans-unit>
<trans-unit id="FirewallRuleCreationFailedWithError">
<source>An error occurred while creating a new firewall rule: '{0}'</source>
<target state="new">An error occurred while creating a new firewall rule: '{0}'</target>
<note></note>
</trans-unit>
</body>
</file>
</xliff>

View File

@@ -0,0 +1,119 @@
//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Composition;
using System.Threading.Tasks;
using Microsoft.SqlTools.Extensibility;
using Microsoft.SqlTools.Hosting;
using Microsoft.SqlTools.Hosting.Protocol;
using Microsoft.SqlTools.ResourceProvider.Core.Authentication;
using Microsoft.SqlTools.ResourceProvider.Core.Contracts;
using Microsoft.SqlTools.ResourceProvider.Core.Firewall;
using Microsoft.SqlTools.Utility;
namespace Microsoft.SqlTools.ResourceProvider.Core
{
[Export(typeof(IHostedService))]
public class ResourceProviderService : HostedService<ResourceProviderService>, IComposableService
{
private const string MssqlProviderId = "MSSQL";
private FirewallRuleService firewallRuleService;
/// <summary>
/// The default constructor is required for MEF-based composable services
/// </summary>
public ResourceProviderService()
{
}
public override void InitializeService(IProtocolEndpoint serviceHost)
{
Logger.Write(LogLevel.Verbose, "ResourceProvider initialized");
serviceHost.SetRequestHandler(CreateFirewallRuleRequest.Type, HandleCreateFirewallRuleRequest);
serviceHost.SetRequestHandler(CanHandleFirewallRuleRequest.Type, ProcessHandleFirewallRuleRequest);
firewallRuleService = new FirewallRuleService()
{
AuthenticationManager = ServiceProvider.GetService<IAzureAuthenticationManager>(),
ResourceManager = ServiceProvider.GetService<IAzureResourceManager>()
};
}
/// <summary>
/// Handles a firewall rule creation request. It does this by matching the server name to an Azure Server resource,
/// then issuing the command to create a new firewall rule for the specified IP address against that instance
/// </summary>
/// <param name="firewallRule"></param>
/// <param name="requestContext"></param>
/// <returns></returns>
public async Task HandleCreateFirewallRuleRequest(CreateFirewallRuleParams firewallRule, RequestContext<CreateFirewallRuleResponse> requestContext)
{
Func<Task<CreateFirewallRuleResponse>> requestHandler = () =>
{
return DoHandleCreateFirewallRuleRequest(firewallRule);
};
await HandleRequest(requestHandler, requestContext, "HandleCreateFirewallRuleRequest");
}
private async Task<CreateFirewallRuleResponse> DoHandleCreateFirewallRuleRequest(CreateFirewallRuleParams firewallRule)
{
var result = new CreateFirewallRuleResponse();
// Note: currently not catching the exception. Expect the caller to this message to handle error cases by
// showing the error string and responding with a clean failure message to the user
try
{
AuthenticationService authService = ServiceProvider.GetService<AuthenticationService>();
IUserAccount account = await authService.SetCurrentAccountAsync(firewallRule.Account, firewallRule.SecurityTokenMappings);
FirewallRuleResponse response = await firewallRuleService.CreateFirewallRuleAsync(firewallRule.ServerName, firewallRule.StartIpAddress, firewallRule.EndIpAddress);
result.Result = true;
}
catch(FirewallRuleException ex)
{
result.Result = false;
result.ErrorMessage = ex.Message;
}
return result;
}
public async Task ProcessHandleFirewallRuleRequest(HandleFirewallRuleParams canHandleRuleParams, RequestContext<HandleFirewallRuleResponse> requestContext)
{
Func<Task<HandleFirewallRuleResponse>> requestHandler = () =>
{
HandleFirewallRuleResponse response = new HandleFirewallRuleResponse();
if (!MssqlProviderId.Equals(canHandleRuleParams.ConnectionTypeId, StringComparison.OrdinalIgnoreCase))
{
response.Result = false;
response.ErrorMessage = SR.FirewallRuleUnsupportedConnectionType;
}
else
{
FirewallErrorParser parser = new FirewallErrorParser();
FirewallParserResponse parserResponse = parser.ParseErrorMessage(canHandleRuleParams.ErrorMessage, canHandleRuleParams.ErrorCode);
response.Result = parserResponse.FirewallRuleErrorDetected;
response.IpAddress = parserResponse.BlockedIpAddress != null ? parserResponse.BlockedIpAddress.ToString() : string.Empty;
}
return Task.FromResult(response);
};
await HandleRequest(requestHandler, requestContext, "HandleCreateFirewallRuleRequest");
}
private async Task HandleRequest<T>(Func<Task<T>> handler, RequestContext<T> requestContext, string requestType)
{
Logger.Write(LogLevel.Verbose, requestType);
try
{
T result = await handler();
await requestContext.SendResult(result);
}
catch (Exception ex)
{
await requestContext.SendError(ex.ToString());
}
}
}
}