@things-factory/auth-base 7.0.1-beta.8 → 7.0.1-rc.0

package/helps/config/publicHomeRoute.md

@@ -1,9 +1,9 @@
 # publicHomeRoute
 
-로그인되지 않은 사용자가 어플리케이션 URL에 처음 접근했을 때, 보여지게 될 페이지의 path를 지정한다.
+specifies the path of the page to be displayed when a user who is not logged in first accesses the application URL.
 
-보통 '/public/home' 패스로 라우팅되어 인트로 화면을 볼 수 있다.
-만약, 로그인 페이지로 바로 이동하고 싶다면, 이 설정을 '/auth/signin' 으로 설정하면 된다.
+usually routed to the '/public/home' path to display the intro screen.
+if you want to go directly to the login page, set this to '/auth/signin'.
 
 ## default
 

package/helps/config/publicHomeRoute.ms.md

@@ -0,0 +1,14 @@
+# publicHomeRoute
+
+menentukan laluan halaman yang akan dipaparkan apabila pengguna yang belum log masuk mengakses URL aplikasi buat kali pertama.
+
+biasanya akan dilalukan ke laluan '/public/home' untuk memaparkan skrin pengenalan.
+jika ingin terus ke halaman log masuk, tetapkan ini ke '/auth/signin'.
+
+## default
+
+```
+module.exports = {
+  publicHomeRoute: '/public/home',
+}
+```

package/helps/config/publicHomeRoute.zh.md

@@ -0,0 +1,14 @@
+# publicHomeRoute
+
+指定未登录用户首次访问应用程序URL时显示的页面路径。
+
+通常会路由到 '/public/home' 路径，以显示介绍页面。
+如果希望直接跳转到登录页面，可以将此设置为 '/auth/signin'。
+
+## default
+
+```
+module.exports = {
+  publicHomeRoute: '/public/home',
+}
+```

package/helps/config/session.ja.md

@@ -0,0 +1,45 @@
+# session
+
+セッション有効期間に関する設定を行うことができます。
+
+- expirySeconds: セッション有効時間（秒単位）
+
+  - この値は、ユーザーセッションが非アクティブの後に何秒で期限切れになるかを定義します。
+  - これを1800に設定すると、30分の非アクティブ後にセッションが期限切れになります。
+
+- expiryPolicy: セッション有効期限ポリシー
+
+  - この設定は、セッションのタイムアウトをどのように管理するかを決定します。
+  - オプション：
+
+    - 'rolling' - セッションのタイムアウトはユーザーのアクティビティに基づいて延長されます。
+      各新しいリクエストは、タイマーを指定されたタイムアウト期間にリセットします。
+    - 'fixed' - セッションのタイムアウトは固定されて
+
+## default
+
+```
+module.exports = {
+  session: {
+    /*
+      Session Expiry Time in Seconds
+      This value defines the duration in seconds after which a user session will expire due to inactivity.
+      Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+    */
+    expirySeconds: 60 * 60 * 24 * 7,
+    /*
+      Session Expiry Policy
+      This setting determines how the session timeout is managed.
+      Options:
+        'rolling' - The session timeout is extended based on user activity.
+                    Each new request resets the timer to the specified timeout duration.
+        'fixed'   - The session timeout is fixed and based on the initial login time.
+                    The session will expire after the specified duration, regardless of user activity.
+
+      Example:
+      expiryPolicy: 'rolling' or 'fixed'
+    */
+    expiryPolicy: 'fixed'
+  },
+}
+```

package/helps/config/session.ko.md

@@ -0,0 +1,49 @@
+# session
+
+세션 유효기간과 관련한 설정을 할 수 있다.
+
+- expirySeconds: Session Expiry Time in Seconds
+
+  - This value defines the duration in seconds after which a user session will expire due to inactivity.
+  - Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+
+- expiryPolicy: Session Expiry Policy
+
+  - This setting determines how the session timeout is managed.
+  - Options:
+
+    - 'rolling' - The session timeout is extended based on user activity.
+      Each new request resets the timer to the specified timeout duration.
+    - 'fixed' - The session timeout is fixed and based on the initial login time.
+      The session will expire after the specified duration, regardless of user activity.
+
+          Example:
+          expiryPolicy: 'rolling' or 'fixed'
+
+## default
+
+```
+module.exports = {
+  session: {
+    /*
+      Session Expiry Time in Seconds
+      This value defines the duration in seconds after which a user session will expire due to inactivity.
+      Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+    */
+    expirySeconds: 60 * 60 * 24 * 7,
+    /*
+      Session Expiry Policy
+      This setting determines how the session timeout is managed.
+      Options:
+        'rolling' - The session timeout is extended based on user activity.
+                    Each new request resets the timer to the specified timeout duration.
+        'fixed'   - The session timeout is fixed and based on the initial login time.
+                    The session will expire after the specified duration, regardless of user activity.
+
+      Example:
+      expiryPolicy: 'rolling' or 'fixed'
+    */
+    expiryPolicy: 'fixed'
+  },
+}
+```

package/helps/config/session.md

@@ -1,23 +1,23 @@
 # session
 
-세션 유효기간과 관련한 설정을 할 수 있다.
+you can set the session expiration settings.
 
 - expirySeconds: Session Expiry Time in Seconds
 
-  - This value defines the duration in seconds after which a user session will expire due to inactivity.
-  - Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+  - this value defines the duration in seconds after which a user session will expire due to inactivity.
+  - setting this to 1800 means the session will expire after 30 minutes of inactivity.
 
 - expiryPolicy: Session Expiry Policy
 
-  - This setting determines how the session timeout is managed.
-  - Options:
+  - this setting determines how the session timeout is managed.
+  - options:
 
-    - 'rolling' - The session timeout is extended based on user activity.
-      Each new request resets the timer to the specified timeout duration.
-    - 'fixed' - The session timeout is fixed and based on the initial login time.
-      The session will expire after the specified duration, regardless of user activity.
+    - 'rolling' - the session timeout is extended based on user activity.
+      each new request resets the timer to the specified timeout duration.
+    - 'fixed' - the session timeout is fixed and based on the initial login time.
+      the session will expire after the specified duration, regardless of user activity.
 
-          Example:
+          example:
           expiryPolicy: 'rolling' or 'fixed'
 
 ## default

package/helps/config/session.ms.md

@@ -0,0 +1,46 @@
+# session
+
+boleh menetapkan tetapan berkaitan tempoh sah sesi.
+
+- expirySeconds: Masa Tamat Sesi dalam Detik
+
+  - nilai ini menentukan tempoh dalam detik selepas mana sesi pengguna akan tamat akibat ketidakaktifan.
+  - menetapkan ini kepada 1800 bermaksud sesi akan tamat selepas 30 minit ketidakaktifan.
+
+- expiryPolicy: Polisi Tamat Sesi
+
+  - tetapan ini menentukan bagaimana masa tamat sesi diuruskan.
+  - pilihan:
+
+    - 'rolling' - masa tamat sesi dilanjutkan berdasarkan aktiviti pengguna.
+      setiap permintaan baru menetapkan semula pemasa kepada tempoh tamat yang ditentukan.
+    - 'fixed' - masa tamat sesi adalah tetap dan berdasarkan masa log masuk awal.
+      sesi akan tamat selepas tempoh yang dit
+
+## default
+
+```
+module.exports = {
+  session: {
+    /*
+      Session Expiry Time in Seconds
+      This value defines the duration in seconds after which a user session will expire due to inactivity.
+      Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+    */
+    expirySeconds: 60 * 60 * 24 * 7,
+    /*
+      Session Expiry Policy
+      This setting determines how the session timeout is managed.
+      Options:
+        'rolling' - The session timeout is extended based on user activity.
+                    Each new request resets the timer to the specified timeout duration.
+        'fixed'   - The session timeout is fixed and based on the initial login time.
+                    The session will expire after the specified duration, regardless of user activity.
+
+      Example:
+      expiryPolicy: 'rolling' or 'fixed'
+    */
+    expiryPolicy: 'fixed'
+  },
+}
+```

package/helps/config/session.zh.md

@@ -0,0 +1,49 @@
+# session
+
+可以设置与会话有效期相关的设置。
+
+- expirySeconds: Session Expiry Time in Seconds
+
+  - 此值定义由于不活动，用户会话将在多少秒后过期。
+  - 将此值设置为1800意味着会话将在30分钟不活动后过期。
+
+- expiryPolicy: Session Expiry Policy
+
+  - 此设置确定如何管理会话超时。
+  - 选项：
+
+    - 'rolling' - 会话超时基于用户活动延长。
+      每个新请求将计时器重置为指定的超时持续时间。
+    - 'fixed' - 会话超时是固定的，基于初始登录时间。
+      无论用户活动如何，会话将在指定的持续时间后过期。
+
+          例子:
+          expiryPolicy: 'rolling' or 'fixed'
+
+## default
+
+```
+module.exports = {
+  session: {
+    /*
+      Session Expiry Time in Seconds
+      This value defines the duration in seconds after which a user session will expire due to inactivity.
+      Setting this to 1800 means the session will expire after 30 minutes of inactivity.
+    */
+    expirySeconds: 60 * 60 * 24 * 7,
+    /*
+      Session Expiry Policy
+      This setting determines how the session timeout is managed.
+      Options:
+        'rolling' - The session timeout is extended based on user activity.
+                    Each new request resets the timer to the specified timeout duration.
+        'fixed'   - The session timeout is fixed and based on the initial login time.
+                    The session will expire after the specified duration, regardless of user activity.
+
+      Example:
+      expiryPolicy: 'rolling' or 'fixed'
+    */
+    expiryPolicy: 'fixed'
+  },
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/auth-base",
-  "version": "7.0.1-beta.8",
+  "version": "7.0.1-rc.0",
   "main": "dist-server/index.js",
   "browser": "dist-client/index.js",
   "things-factory": true,
@@ -30,10 +30,10 @@
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
   },
   "dependencies": {
-    "@things-factory/email-base": "^7.0.1-beta.8",
-    "@things-factory/env": "^7.0.1-beta.6",
-    "@things-factory/shell": "^7.0.1-beta.8",
-    "@things-factory/utils": "^7.0.1-beta.6",
+    "@things-factory/email-base": "^7.0.1-rc.0",
+    "@things-factory/env": "^7.0.1-rc.0",
+    "@things-factory/shell": "^7.0.1-rc.0",
+    "@things-factory/utils": "^7.0.1-rc.0",
     "@types/webappsec-credential-management": "^0.6.8",
     "jsonwebtoken": "^9.0.0",
     "koa-passport": "^6.0.0",
@@ -45,5 +45,5 @@
     "passport-local": "^1.0.0",
     "popsicle-cookie-jar": "^1.0.0"
   },
-  "gitHead": "d2ca60f7fca6feb2b7cb86b4f825378573fcc335"
+  "gitHead": "45476b164b69aef2c211d9a5257897f42d8e2f5f"
 }

package/server/constants/error-code.ts

@@ -17,3 +17,4 @@ export const PASSWORD_USED_PAST = 'password used in the past'
 export const VERIFICATION_ERROR = 'user or verification token not found'
 export const USER_CREDENTIAL_NOT_FOUND = 'user credential not found'
 export const AUTH_ERROR = 'auth error'
+export const FIDO2_CERT_UNSUPPORTED = 'fido2 certificate unsupported'

package/server/middlewares/webauthn-middleware.ts

@@ -24,7 +24,12 @@ passport.use(
         return cb(null, false, { errorCode: AuthError.ERROR_CODES.USER_CREDENTIAL_NOT_FOUND })
       }
 
-      return cb(null, user, credential.publicKey)
+      try {
+        return cb(null, user, credential.publicKey)
+      } catch (error) {
+        console.error(error)
+        return cb(null, false, { errorCode: AuthError.ERROR_CODES.FIDO2_CERT_UNSUPPORTED })
+      }
     },
     async function register(user, id, publicKey, cb) {
       const userObject = await getRepository(User).findOne({ where: { id: user.id.toString() } })

package/server/service/app-binding/app-binding-query.ts

@@ -22,7 +22,7 @@ export class AppBindingQuery {
 
   /* TODO optimize query */
   @Query(returns => AppBindingList)
-  async appBindings(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<UserList> {
+  async appBindings(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<UserList> {
     const { domain } = context.state
 
     // const convertedParams = convertListParams(params)

package/server/service/appliance/appliance-query.ts

@@ -17,7 +17,10 @@ export class ApplianceQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => ApplianceList, { description: 'To fetch multiple appliance' })
-  async appliances(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ApplianceList> {
+  async appliances(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<ApplianceList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({
@@ -35,7 +38,7 @@ export class ApplianceQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => ApplianceList, { description: 'To fetch multiple appliance' })
-  async edges(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ApplianceList> {
+  async edges(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<ApplianceList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/application/application-query.ts

@@ -24,7 +24,7 @@ export class ApplicationQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => ApplicationList, { description: 'To fetch multiple application' })
-  async applications(@Args() params: ListParam, @Ctx() context: ResolverContext) {
+  async applications(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext) {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/application/application.ts

@@ -131,14 +131,14 @@ export class Application {
   updatedAt?: Date
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   creator?: User
 
   @RelationId((application: Application) => application.creator)
   creatorId?: string
 
   @ManyToOne(type => User, { nullable: true })
-  @Field({ nullable: true })
+  @Field(type => User, { nullable: true })
   updater?: User
 
   @RelationId((application: Application) => application.updater)

package/server/service/auth-provider/auth-provider-query.ts

@@ -25,7 +25,10 @@ export class AuthProviderQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => AuthProviderList, { description: 'To fetch multiple AuthProviders' })
-  async authProviders(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<AuthProviderList> {
+  async authProviders(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<AuthProviderList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/login-history/login-history-query.ts

@@ -9,7 +9,10 @@ import { LoginHistoryList } from './login-history-type'
 @Resolver(LoginHistory)
 export class LoginHistoryQuery {
   @Query(returns => LoginHistoryList, { description: 'To fetch multiple LoginHistories' })
-  async loginHistories(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<LoginHistoryList> {
+  async loginHistories(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<LoginHistoryList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/partner/partner-query.ts

@@ -12,7 +12,7 @@ import { PartnerList } from './partner-types'
 export class PartnerQuery {
   @Directive('@privilege(category: "partner", privilege: "query", domainOwnerGranted: true)')
   @Query(returns => PartnerList)
-  async partners(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<PartnerList> {
+  async partners(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<PartnerList> {
     if (await checkUserBelongsDomain(context.state.domain, context.state.user)) {
       const { domain } = context.state
 
@@ -45,7 +45,10 @@ export class PartnerQuery {
 
   @Directive('@privilege(category: "partner", privilege: "query")')
   @Query(returns => DomainList)
-  async searchCustomers(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<DomainList> {
+  async searchCustomers(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<DomainList> {
     const { domain } = context.state
     const partners: Partner[] = await getRepository(Partner).find({
       where: { domain: { id: domain.id } },

package/server/service/privilege/privilege-query.ts

@@ -10,7 +10,10 @@ import { PrivilegeList } from './privilege-types'
 export class PrivilegeQuery {
   @Directive('@privilege(category: "privilege", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => PrivilegeList, { description: 'To fetch multiple privileges' })
-  async privileges(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<PrivilegeList> {
+  async privileges(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<PrivilegeList> {
     const [items, total] = await getQueryBuilderFromListParams({
       params,
       repository: getRepository(Privilege),
@@ -29,13 +32,21 @@ export class PrivilegeQuery {
   }
 
   @Query(returns => Boolean, { description: 'To query whether I have the given permission' })
-  async hasPrivilege(@Arg('privilege') privilege: string, @Arg('category') category: string, @Ctx() context: ResolverContext): Promise<Boolean> {
+  async hasPrivilege(
+    @Arg('privilege') privilege: string,
+    @Arg('category') category: string,
+    @Ctx() context: ResolverContext
+  ): Promise<Boolean> {
     const { domain, user } = context.state
     return await User.hasPrivilege(privilege, category, domain, user)
   }
 
   @Query(returns => [Domain], { description: 'To fetch domains with given privilege for user' })
-  async domainsWithPrivilege(@Arg('privilege') privilege: string, @Arg('category') category: string, @Ctx() context: ResolverContext): Promise<Partial<Domain>[]> {
+  async domainsWithPrivilege(
+    @Arg('privilege') privilege: string,
+    @Arg('category') category: string,
+    @Ctx() context: ResolverContext
+  ): Promise<Partial<Domain>[]> {
     const { user } = context.state
     return await User.getDomainsWithPrivilege(privilege, category, user)
   }

package/server/service/role/role-query.ts

@@ -24,7 +24,7 @@ export class RoleQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => RoleList, { description: 'To fetch multiple users' })
-  async roles(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<RoleList> {
+  async roles(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<RoleList> {
     const { domain } = context.state
 
     const [items, total] = await getQueryBuilderFromListParams({

package/server/service/user/user-query.ts

@@ -27,7 +27,7 @@ export class UserQuery {
 
   @Directive('@privilege(category: "user", privilege: "query", domainOwnerGranted: true, superUserGranted: true)')
   @Query(returns => UserList, { description: 'To fetch multiple users' })
-  async users(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<UserList> {
+  async users(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<UserList> {
     const { domain } = context.state
 
     const qb = getQueryBuilderFromListParams({

package/translations/en.json

@@ -4,6 +4,7 @@
   "error.domain mismatch": "certificate is not for this domain",
   "error.domain not allowed": "user not allowed domain `{subdomain}`",
   "error.failed to find x": "failed to find {x}",
+  "error.fido2 certificate unsupported": "FIDO2 certificate unsupported",
   "error.password should match the rule": "password should match following rule. ${rule}",
   "error.password used in the past": "password used in the past",
   "error.subdomain not found": "domain not found",

package/translations/ja.json

@@ -4,6 +4,7 @@
   "error.domain mismatch": "証明書のドメインと現在のドメインが一致しません.",
   "error.domain not allowed": "'{subdomain}' 領域はこのユーザに許可されていません.",
   "error.failed to find x": "{x}が見つかりません.",
+  "error.fido2 certificate unsupported": "fido2証明書はサポートされていません",
   "error.password should match the rule": "パスワードは次の規則を守らなければなりません. {rule}",
   "error.password used in the past": "過去に使用されたパスワードです.",
   "error.subdomain not found": "サブドメインが見つかりません.",

package/translations/ko.json

@@ -4,6 +4,7 @@
   "error.domain mismatch": "인증서의 도메인과 현재 도메인이 일치하지 않습니다.",
   "error.domain not allowed": "'{subdomain}' 영역은 이 사용자에게 허가되지 않았습니다.",
   "error.failed to find x": "{x}을(를) 찾을 수 없습니다.",
+  "error.fido2 certificate unsupported": "제공된 인증서가 올바르지 않거나 지원되지 않는 형식입니다. 다른 로그인 방법을 사용하세요.",
   "error.password should match the rule": "비밀번호는 다음 규칙을 지켜야 합니다. {rule}",
   "error.password used in the past": "과거에 사용된 비밀번호입니다.",
   "error.subdomain not found": "서브도메인을 찾을 수 없습니다.",

package/translations/ms.json

@@ -4,6 +4,7 @@
   "error.domain mismatch": "Sijil tidak sesuai untuk domain ini",
   "error.domain not allowed": "Pengguna tidak dibenarkan domain `{subdomain}`",
   "error.failed to find x": "Gagal mencari {x}",
+  "error.fido2 certificate unsupported": "sijil fido2 tidak disokong",
   "error.password should match the rule": "Kata laluan harus mematuhi peraturan berikut. ${rule}",
   "error.password used in the past": "Kata laluan telah digunakan dalam masa lampau",
   "error.subdomain not found": "Domain tidak ditemui",

package/translations/zh.json

@@ -4,6 +4,7 @@
   "error.domain mismatch": "证书不适用于该域！",
   "error.domain not allowed": "用户无权限使用`{subdomain}`域！",
   "error.failed to find x": "查询{x}失败！",
+  "error.fido2 certificate unsupported": "fido2证书不支持",
   "error.password should match the rule": "密码应符合以下规则。${rule}",
   "error.password used in the past": "使用过的密码！",
   "error.subdomain not found": "用户域查询失败！",