com.EBS.Common.Application 1.6.7.48

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package com.EBS.Common.Application --version 1.6.7.48
                    


                    

                
NuGet\Install-Package com.EBS.Common.Application -Version 1.6.7.48
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="com.EBS.Common.Application" Version="1.6.7.48" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="com.EBS.Common.Application" Version="1.6.7.48" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="com.EBS.Common.Application" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add com.EBS.Common.Application --version 1.6.7.48
                    


                    

                
#r "nuget: com.EBS.Common.Application, 1.6.7.48"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package com.EBS.Common.Application@1.6.7.48
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=com.EBS.Common.Application&version=1.6.7.48
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=com.EBS.Common.Application&version=1.6.7.48
                    


                            Install as a Cake Tool

EBS.Common

I.Configuration

1.application.json

{
    "App": {
        "SelfUrl": "https://xxx.xx",
        "CorsOrigins":"AllowAll,https://xxx.xx",
        "AppUrlOptions":{
            "RedirectAllowedUrls":"https://xxx.xx,https://yyy.yy",
            "Applications": {
                "MVC": {
                    "RootUrl": "http://xx:8080",
                    "Urls": {
                        "Abp.Account.PasswordReset": "account/reset-password"
                    }
                },
                "Angular": {
                    "RootUrl": "http://xx:8080",
                    "Urls": {
                        "Abp.Account.PasswordReset": "account/reset-password"
                    }
                }
            },
        },
        "OpenIddictServerSetting": {
          "IsEnableAutherServer": true,
          "AccessTokenLifetime": 60,
          "RefreshTokenLifetime": 20_160,
          "SigningCertificate": {
            "Path": "xxx\\SigningCertificate.pfx",
            "Password": "anypass",
            "DistinguishedName":"CN=EBS Signing Certificate",
            "KeyStorageFlags": "MachineKeySet, PersistKeySet, Exportable",//X509KeyStorageFlags
            "ExpireDay": 3_650,
            "KeySizeInBits": 4_096
          },
          "EncryptionCertificate": {
            "Path": "xxx\\EncryptionCertificate.pfx",
            "Password": "anypass",
            "DistinguishedName":"CN=EBS Encryption Certificate",
            "KeyStorageFlags": "MachineKeySet, PersistKeySet, Exportable",//X509KeyStorageFlags
            "ExpireDay": 3_650,
            "KeySizeInBits": 4_096
          }
        }
    },
    "ConnectionStrings": {
        "Encrypted.Default": "xxx",
        "Encrypted.HangfireConnection": "xxx",
        "Encrypted.connect-name": "xxx"
    },
    "Settings":{
        "IsEnableHangfireServer": true,
        "BackgroundJob":{
            "IsEnable": true,
            "JobPollPeriod": 30000,
            "MaxJobFetchCount": 200
        },
        "MappedConnections": {
            "connect-name":["map-name-1","map-name-2"]
        },
        "DistributedLock":{
            "KeyPrefix":"EbsApplication"
        },
        "DistributedCache":{
            "KeyPrefix":"EbsApplication"
        },
        "DataProtection":{
            "ApplicationName":"ebsApplication",
            "PersistKeys":"ebs-service-Protection-Keys",
            "PathFolder": string?
        },
        "ForwardedHeadersOptions": {
          "ForwardedHeaders": null, // Docker/k8s prefer= "XForwardedFor, XForwardedProto, XForwardedHost" => .well-known/openid-configuration.jwks_uri = https ; use "app.UseForwardedHeaders();"
          "ClearKnownNetworksProxies":null// true => .well-known/openid-configuration.jwks_uri = https ; use "app.UseForwardedHeaders();"
        },
        "TokenX509MfaOption": {
            "MaxTimeoutSecond": 90
        }
    },
    "Redis":{
        "IsEnabled": false,
        "Encrypted.Configuration":"xxxxx", // or "Configuration"
        "ApplicationName":"ebsApplication",
        "IsSentinel": false,
        "ServiceName": string?
    },
    "WebPages":{
        "ButtonResourceName":"IShopEBS"
    },
    "Swagger": {
        "IsActive": true,
        "IsWithOAuth": true,
        "LastIsAll": true,
        "XmlFileName": "abc.xml",
        "Scopes": {
            "IShopEBS": "EBS API"
        },
        "Docs":{
            "DocName1":{ // is Microsoft.OpenApi.Models.OpenApiInfo
                "Title": "All Api"
            }
        }
    },
    "AuthServer":{
        "SwaggerClientId":"SwaggerDev",
        "Authority":"https://xxxx.com"
    },
    "Minio":{
        "Endpoint":"xxx",
        "AccessKey": "[Optional]",
        "SecretKey": "[Optional]",
        "HealthChecks": true,
        "Secure": true,
        "Encrypted.AccessKey": "[Optional]",
        "Encrypted.SecretKey": "[Optional]"
    },
    "ApplicationFileOptions": {
        "key": "value"
    },
    "Templates":{
        "Items" :{
            "key1":{
                "StoreName": "abc"
            }
        }
    },
    "Integrations":{
        "VMG":{
            "BrandNameDefault":"EBS",
            "ApiSendSMS":"https://api.brandsms.vn/api/SMSBrandname/SendSMS",
            "Token":xxx,
            "MaxLengthMessage": 612
        }
    }
}

II.Modules and Handlers

IdentityClientModule

{
    "IdentityClients": {
        "AuthSSO": {
            "Authority": "https://localhost:44320",
            "GrantType": "client_credentials",
            "ClientId": "PortalToSSO",
            "ClientSecret": "Vpa@2026!88x",
            "Scope": "inter-remote",
            "RequireHttps": false,
            "MapInboundClaims": false,
            //"IncludeUrls": null,
            //"IgnoreUrls": null,
            "PermissionPath": "https://localhost:44320/api/app/inter-remote/permission/{0}"
        }
    },
    "IdentityClientEncrypt": {
        "EncryptedMode": "Encryptedx2",
        "Keys": [ "ClientId" ]
    },
    "RemoteServices": {
        "ServiceA": {
            "BaseUrl": "https://localhost:443xx",
            "IdentityClient": "AuthSSO"
        }
    }
}

ConfigureAuthentication()
{
    context.Services.AddAuthentication(...).AddIdentityClientJwtBearer();
}
  1. Service/method
[Authorize(AuthenticationSchemes = "AuthSSO", Policy = CommonPermissions.AuditLog)]
  1. AutoApi (optional)
PreConfigureServices()
{
    //optional
    context.Services.Configure<MvcOptions>(options =>
    {
        options.Conventions.Add(SsoAuthenticationConvention());
    });
}
public class SsoAuthenticationConvention : Microsoft.AspNetCore.Mvc.ApplicationModels.IControllerModelConvention
{
    public void Apply(ControllerModel controller)
    {
        // Chỉ controller thuộc namespace/package AuditLog
        if (controller.ControllerType.FullName?.StartsWith(typeof(AuditLogService).FullName) ?? false)
        {
            var authorize1 = controller.Attributes.OfType<AuthorizeAttribute>().FirstOrDefault();
            authorize1?.AuthenticationSchemes = "AuthSSO";
            foreach (var action in controller.Actions)
            {
                var authorize = action.Attributes
                       .OfType<AuthorizeAttribute>()
                       .FirstOrDefault();
                authorize?.AuthenticationSchemes = "AuthSSO";
            }
        }
    }
}

OneDeviceSignInModule

Setting

{
    "App": {
        "OpenIddictServerSetting": {
            "OneDevice": {
                "IsEnableExchangeToken": true
            }
        }
    }
}

EnableExchangeToken:

/*Create exchangeCode*/
POST: <sso-domain>/api/app/auth-profile/require-exchange-token

/*Change code->token*/
curl --location '<sso-domain>/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Urn-EToken-Exchange: <exchangeCode>' \
--data-urlencode 'grant_type=urn:ebs:token-exchange' \
--data-urlencode 'client_id=<....>' \
--data-urlencode 'scope=<.....>' \
--data-urlencode 'token_type_hint=e_exchange_code' \
--data-urlencode 'token=<exchangeCode>'

Use AttachTokens

Sử dụng để attach sso-id vào header request , không cần add access_token khi gọi api từ web/host đến authserver và service

  1. AuthServer DependsOn AttachTokenAuthServerModule
  2. Web/Host DependsOn AttachTokenServiceModule

RoleGuardEfCoreModule

Protect role.

  1. Config module
public override void ConfigureServices(ServiceConfigurationContext context)
{
    Configure<AbpDbContextOptions>(options =>
    {
        options.Configure<AuthDbContext>(dbContextOptions =>
        {
            dbContextOptions.UseSqlServer().AddInterceptors(dbContextOptions.ServiceProvider.GetRequiredService<IdentityUserSaveChangesInterceptor>());
        });
    });
}
  1. Role Extra property
role.SetProperty(RoleGuardConsts.IsGuardExtrapropertyName,true);

CommonApplicationModule

Config redis, distributed cache, distributed lock, data protection, forwarded headers, token x509 mfa option...

CommonWebModule

Config swagger, authserver, cors...

DefaultHtml2PdfRenderModule

Generate Html → pdf, email body... Use IHtml2PdfRender, ISignHandler

  1. Set CertContainer
  2. Default Folder BankEncrypt
  3. Copy file in font to Environment.CurrentDirectory/Exports/Fonts
  4. Text-Template in ContentRootPath/Exports/host/text-template/<template-name>/<language>.html ; Default en.html

EBSMinioBlobModule

Store Blob on Minio

  1. Imp IFileStore
  2. Config IOptions<ContainerTypeDefaultOption>

GenerateEmailingHandler

Generate email body and attach file (pdf, excel, word...) to email

  1. Impl + Add Service: IEmailingStoreRepository
  2. Impl + Add service: IGenerateEmailingGetFileDataHandler
  3. context.Services.AddTransient<IGenerateEmailingHandler, GenerateEmailingHandler>();

MaskingModule

Setting:

{
  "Masking": {
    "Rules": [
      {
        "Service": "PROJECT.HostService.IdentityUserAppService",//Service fullname
        "Method": "GetListAsync",//method name
        "Properties": [
          {
            "Property": "Email",
            "Type": "Email"
          },
          {
            "Property": "PhoneNumber",
            "Type": "Phone"
          }
        ]
      }
    ]
  }
}

Code:

/*dto*/
public class MaskOutputDto : EntityDto<Guid>
{
    [Mask(MaskType.Email)]
    public string Email { get; set; } = null!;

    [Mask(MaskType.IdentityNumber)]
    public string TaxCode { get; set; } = null!;

    [Mask(MaskType.IdentityNumber)]
    public string OrgLeaderNumber { get; set; } = null!;

    [Mask(MaskType.Phone)]
    public string? Phonenumber { get; set; }
}

/*method*/
[MaskOutputActionFilter]
public Task<PagedResultDto<MaskOutputDto>> GetListAsync();

/*Service*/
[MaskOutputActionFilter]
public class YourService
{
}

EbsMailGunApiModule

Send mail via IEmailSender by MailGun provider. Config

curl -X 'POST' \
  'https://<domain>/api/setting-management/emailing' \
  -H 'Content-Type: application/json' \
  -d '{
  "smtpHost": "https://api.mailgun.net/<resource-url>",
  "smtpUserName": "<username>",
  "smtpPassword": "<pass>",
  "defaultFromAddress": "yourmail@yourdomain.xxom"
}'

ZozoMailModule

Send mail via IEmailSender by Zozo provider. Setting:

{
  "Integrations": {
    "ZozoEmail": {
      "TimeoutSeconds": 120
    }
  }
}

Config

curl -X 'POST' \
  'https://<domain>/api/setting-management/emailing' \
  -H 'Content-Type: application/json' \
  -d '{
  "smtpHost": "<api-url>",
  "smtpPassword": "<api-token>",
  "defaultFromAddress": "yourmail@yourdomain.com",
  "defaultFromDisplayName": "<display-name>"
}'

EInvoiceVnptModule

Use e-Invoice by VNPT provider

IEInvoiceVnptHandler

GenerateCodeModule

Generate code (no-duplicate) for entity. Use

1. IGenerateCodeManager, 
2. ICacheShowroomNameHandler

VMGSmsModule

Send sms via VMG provider

IVMGConnectHandler

ExportExcelWorker

Export data to excel file Use:

1. IExportExcelWorker

III.Services

TextTemplateDefinition

Use

1. IRepository<TextTemplateDefinition, Guid> repository,
2. IRepository<TextTemplateDefinitionHistory, Guid> repositoryHis,
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.6.7.48 46 9/25/2026
1.6.7.37 81 9/21/2026
1.6.7.35 79 9/18/2026
1.6.7.24 81 9/15/2026
1.6.7.14 86 9/11/2026

app common 4 all proj