Pericia.Storage.FileSystem 4.1.0

Pericia.Storage

Storage abstraction to store file in local file system or cloud storage.

Providers available for :

• File system
• MinIO
• OpenStack
• Azure Blobs
• AWS S3
• In-memory

How to use

The Pericia.Storage library provides an abstraction for cloud file storages. It is basically two interfaces :

• IFileStorage : represents a file storage services, which contains containers (identified by name)
• IFileStorageContainer : represents a container in the service, where the files will be stored.

IFileStorage contains the following method :

• IFileStorageContainer GetContainer(string container); : get a container for the current storage service.

IFileStorageContainer contains the following methods :

• Task<string> SaveFile(Stream fileData, string fileId) : Save a file to the storage service, using its unique identifier. If a file with the same id exists, it is overwritten.

• Task<string> SaveFile(Stream fileData) : save a file to the storage service, and returns the generated unique id of the file.

• Task<Stream> GetFile(string fileId) : get the file content from the service

• Task DeleteFile(string fileId) : delete the file from the service

Usage

You can use the service using one of the providers (see below for details on each provider). First thing to do is to add the Nuget package for your provider.

Direct usage

Each provider has a constructor with a single parameter containing the options (specific for each provider).

FileSystemStorageOptions options = new FileSystemStorageOptions() { Path = @"C:\files\" };
var fileService = new FileSystemStorage(options);

var container1 = fileService.GetContainer("container1");

Or you can directly use the container class :

var container2 = new FileSystemStorageContainer(options, "container2");

Usage with IoC

The packages contains helpers to register the services in you aspnet core IoC. First, use AddStorage to register the storage service, then add your provider, with its configuration :

public void ConfigureServices(IServiceCollection services)
{
	var storageConfig = Configuration.GetSection("Storage");
	services.AddStorage().AddFileSystem(storageConfig);
}

If you want to be able to switch provider in your configuration, you can set the provider key in the Provider property of the options. Then you can add several providers, only the one in configuration will be registered :

services.AddStorage().AddFileSystem(storageConfig).AddAzureBlobs(storageConfig).AddOpenStack(storageConfig);

If you only want to use one container in your app, you can register it directly :

services.AddStorage().AddFileSystem(storageConfig).AddContainer("container1");

Providers

File System

This provider saves the files on the hard drive.

The only option needed is Path, the directory path.

Provider key : FileSystem

MinIO

Saves the files to MinIO or any S3-compatible service

The options needed are the AccessKey, SecretKey, and Endpoint (the url host, without the 'https://' part).

If your service endpoint is not accessible with https, you can add the option Insecure = true.

Some S3 services may throw an error "The authorization header is malformed; the region 'us-east-1' is wrong; expecting 'xxx'". You can add the expected region to the options with key Region.

Provider key : MinIO

OpenStack

Saves to OpenStack. The following options are needed :

• ApiEndpoint : the openstack api url
• AuthEndpoint : the authentication url
• TenantName
• UserId
• Password
• AuthApiVersion : set this value to 2 if you want to use the v2 authentication API. If not set, the V3 API will be used.

Provider key : OpenStack

Azure blobs

Saves the files to Azure Blob storage.

The only option needed is the ConnectionString

Provider key : Azure

AWS S3

Saves the files to AWS S3

The options needed are the AccessKey, SecretKey, and either the RegionEndpoint (for AWS) or ServiceUrl (for S3-compatible providers)

If you use a S3-Compatible service, you should use the Minio provider instead

Provider key : AwsS3

In-memory

Store data in-memory - for testing purpose.

Persist Data Protection keys

When Pericia.Storage is configured for your app, you can use it to save the data protection keys, with the package Pericia.Storage.AspNetCore.DataProtection.

services.AddDataProtection()
	.PersistKeysToPericiaStorage()
	.ProtectKeysWithCertificate(cert);

You can use the default container, or you can choose to store the keys in a different container or in a sub-folder

services.AddDataProtection()
    .PersistKeysToPericiaStorage(container: "keyscontainer", subDirectory: "keysdirectory")
    .ProtectKeysWithCertificate(cert);