URL-encode blob name parameters (Azure#19670)

* URL-encode blob name parameters

* add targeted tests

* update recordings

Author: jhendrixMSFT

sdk/storage/azblob/CHANGELOG.md

@@ -21,6 +21,7 @@
 * Corrected signing of User Delegation SAS. Fixes [#19372](https://github.com/Azure/azure-sdk-for-go/issues/19372) and [#19454](https://github.com/Azure/azure-sdk-for-go/issues/19454)
 * Added formatting of start and expiry time in [SetAccessPolicy](https://learn.microsoft.com/rest/api/storageservices/set-container-acl#request-body). Fixes [#18712](https://github.com/Azure/azure-sdk-for-go/issues/18712)
 * Uploading block blobs larger than 256MB can fail in some cases with error `net/http: HTTP/1.x transport connection broken`.
+* Blob name parameters are URL-encoded before constructing the complete blob URL.
 
 ### Other Changes
 

sdk/storage/azblob/container/client.go

@@ -10,6 +10,7 @@ import (
 	"context"
 	"errors"
 	"net/http"
+	"net/url"
 	"time"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
@@ -106,41 +107,38 @@ func (c *Client) URL() string {
 	return c.generated().Endpoint()
 }
 
-// NewBlobClient creates a new BlobClient object by concatenating blobName to the end of
-// Client's URL. The new BlobClient uses the same request policy pipeline as the Client.
-// To change the pipeline, create the BlobClient and then call its WithPipeline method passing in the
-// desired pipeline object. Or, call this package's NewBlobClient instead of calling this object's
-// NewBlobClient method.
+// NewBlobClient creates a new blob.Client object by concatenating blobName to the end of
+// Client's URL. The blob name will be URL-encoded.
+// The new blob.Client uses the same request policy pipeline as this Client.
 func (c *Client) NewBlobClient(blobName string) *blob.Client {
+	blobName = url.PathEscape(blobName)
 	blobURL := runtime.JoinPaths(c.URL(), blobName)
 	return (*blob.Client)(base.NewBlobClient(blobURL, c.generated().Pipeline(), c.sharedKey()))
 }
 
-// NewAppendBlobClient creates a new AppendBlobURL object by concatenating blobName to the end of
-// Client's URL. The new AppendBlobURL uses the same request policy pipeline as the Client.
-// To change the pipeline, create the AppendBlobURL and then call its WithPipeline method passing in the
-// desired pipeline object. Or, call this package's NewAppendBlobClient instead of calling this object's
-// NewAppendBlobClient method.
+// NewAppendBlobClient creates a new appendblob.Client object by concatenating blobName to the end of
+// this Client's URL. The blob name will be URL-encoded.
+// The new appendblob.Client uses the same request policy pipeline as this Client.
 func (c *Client) NewAppendBlobClient(blobName string) *appendblob.Client {
+	blobName = url.PathEscape(blobName)
 	blobURL := runtime.JoinPaths(c.URL(), blobName)
 	return (*appendblob.Client)(base.NewAppendBlobClient(blobURL, c.generated().Pipeline(), c.sharedKey()))
 }
 
-// NewBlockBlobClient creates a new BlockBlobClient object by concatenating blobName to the end of
-// Client's URL. The new BlockBlobClient uses the same request policy pipeline as the Client.
-// To change the pipeline, create the BlockBlobClient and then call its WithPipeline method passing in the
-// desired pipeline object. Or, call this package's NewBlockBlobClient instead of calling this object's
-// NewBlockBlobClient method.
+// NewBlockBlobClient creates a new blockblob.Client object by concatenating blobName to the end of
+// this Client's URL. The blob name will be URL-encoded.
+// The new blockblob.Client uses the same request policy pipeline as this Client.
 func (c *Client) NewBlockBlobClient(blobName string) *blockblob.Client {
+	blobName = url.PathEscape(blobName)
 	blobURL := runtime.JoinPaths(c.URL(), blobName)
 	return (*blockblob.Client)(base.NewBlockBlobClient(blobURL, c.generated().Pipeline(), c.sharedKey()))
 }
 
-// NewPageBlobClient creates a new PageBlobURL object by concatenating blobName to the end of Client's URL. The new PageBlobURL uses the same request policy pipeline as the Client.
-// To change the pipeline, create the PageBlobURL and then call its WithPipeline method passing in the
-// desired pipeline object. Or, call this package's NewPageBlobClient instead of calling this object's
-// NewPageBlobClient method.
+// NewPageBlobClient creates a new pageblob.Client object by concatenating blobName to the end of
+// this Client's URL. The blob name will be URL-encoded.
+// The new pageblob.Client uses the same request policy pipeline as this Client.
 func (c *Client) NewPageBlobClient(blobName string) *pageblob.Client {
+	blobName = url.PathEscape(blobName)
 	blobURL := runtime.JoinPaths(c.URL(), blobName)
 	return (*pageblob.Client)(base.NewPageBlobClient(blobURL, c.generated().Pipeline(), c.sharedKey()))
 }

sdk/storage/azblob/container/client_test.go

@@ -9,6 +9,7 @@ package container_test
 import (
 	"context"
 	"fmt"
+	"net/url"
 	"sort"
 	"strconv"
 	"strings"
@@ -2156,3 +2157,29 @@ func (s *ContainerRecordedTestsSuite) TestSetAccessPolicyWithNullId() {
 	_require.Nil(err)
 	_require.Len(resp.SignedIdentifiers, 0)
 }
+
+func (s *ContainerUnrecordedTestsSuite) TestBlobNameSpecialCharacters() {
+	_require := require.New(s.T())
+
+	const containerURL = testcommon.FakeStorageURL + "/fakecontainer"
+	client, err := container.NewClientWithNoCredential(containerURL, nil)
+	_require.NoError(err)
+	_require.NotNil(client)
+
+	blobNames := []string{"foo%5Cbar", "hello? sausage/Hello.txt", "世界.txt"}
+	for _, blobName := range blobNames {
+		expected := containerURL + "/" + url.PathEscape(blobName)
+
+		abc := client.NewAppendBlobClient(blobName)
+		_require.Equal(expected, abc.URL())
+
+		bbc := client.NewBlockBlobClient(blobName)
+		_require.Equal(expected, bbc.URL())
+
+		pbc := client.NewPageBlobClient(blobName)
+		_require.Equal(expected, pbc.URL())
+
+		bc := client.NewBlobClient(blobName)
+		_require.Equal(expected, bc.URL())
+	}
+}

sdk/storage/azblob/service/client.go

@@ -120,11 +120,8 @@ func (s *Client) URL() string {
 	return s.generated().Endpoint()
 }
 
-// NewContainerClient creates a new ContainerClient object by concatenating containerName to the end of
-// Client's URL. The new ContainerClient uses the same request policy pipeline as the Client.
-// To change the pipeline, create the ContainerClient and then call its WithPipeline method passing in the
-// desired pipeline object. Or, call this package's NewContainerClient instead of calling this object's
-// NewContainerClient method.
+// NewContainerClient creates a new container.Client object by concatenating containerName to the end of
+// this Client's URL. The new container.Client uses the same request policy pipeline as the Client.
 func (s *Client) NewContainerClient(containerName string) *container.Client {
 	containerURL := runtime.JoinPaths(s.generated().Endpoint(), containerName)
 	return (*container.Client)(base.NewContainerClient(containerURL, s.generated().Pipeline(), s.sharedKey()))