@things-factory/auth-base 7.0.1-beta.18 → 7.0.1-beta.23

package/helps/config/SECRET.ja.md

@@ -0,0 +1,13 @@
+# SECRET
+
+すべてのアプリケーションは、以下のサンプルのように独自のSECRETキーを指定する必要があります。
+この設定は、認証用のjwtキーを生成する際の暗号化SEEDとして使用されます。
+したがって、新しくデプロイされた場所で独自のSECRETキーを指定しないと、デフォルト値（すでに知られている可能性がある）が使用されるため、セキュリティが脆弱になる可能性があります。
+
+## default
+
+```
+module.exports = {
+  SECRET: '0xD58F835B69D207A76CC5F84a70a1D0d4C79dAC95',
+}
+```

package/helps/config/SECRET.ko.md

@@ -0,0 +1,13 @@
+# SECRET
+
+모든 어플리케이션은 아래 샘플과 같이 독자적인 SECRET 키를 지정하여야 한다.
+이 설정은 인증을 위한 jwt key 생성시 암호화를 위한 SEED로 사용된다.
+따라서, 새로 디플로이된 곳에 독자적인 SECRET 키를 새로 지정하지 않으면, (이미 알려져있을 수 있는) 디폴트 값이 사용되므로 보안에 취약해질 수 있다.
+
+## default
+
+```
+module.exports = {
+  SECRET: '0xD58F835B69D207A76CC5F84a70a1D0d4C79dAC95',
+}
+```

package/helps/config/SECRET.md

@@ -1,8 +1,8 @@
 # SECRET
 
-모든 어플리케이션은 아래 샘플과 같이 독자적인 SECRET 키를 지정하여야 한다.
-이 설정은 인증을 위한 jwt key 생성시 암호화를 위한 SEED로 사용된다.
-따라서, 새로 디플로이된 곳에 독자적인 SECRET 키를 새로 지정하지 않으면, (이미 알려져있을 수 있는) 디폴트 값이 사용되므로 보안에 취약해질 수 있다.
+all applications must specify a unique SECRET key as shown in the sample below.
+this setting is used as the SEED for encryption when generating the jwt key for authentication.
+therefore, if a unique SECRET key is not specified in a newly deployed location, the default value (which may already be known) will be used, potentially compromising security.
 
 ## default
 

package/helps/config/SECRET.ms.md

@@ -0,0 +1,13 @@
+# SECRET
+
+semua aplikasi mesti menetapkan kunci SECRET yang unik seperti dalam contoh di bawah.
+tetapan ini digunakan sebagai SEED untuk penyulitan semasa menghasilkan kunci jwt untuk pengesahan.
+oleh itu, jika kunci SECRET yang unik tidak ditetapkan di tempat yang baru diterapkan, nilai lalai (yang mungkin sudah diketahui) akan digunakan, yang boleh menyebabkan kelemahan keselamatan.
+
+## default
+
+```
+module.exports = {
+  SECRET: '0xD58F835B69D207A76CC5F84a70a1D0d4C79dAC95',
+}
+```

package/helps/config/SECRET.zh.md

@@ -0,0 +1,13 @@
+# SECRET
+
+所有应用程序必须指定一个独特的SECRET键，如下面的示例所示。
+此设置用于生成jwt密钥时的加密SEED。
+因此，如果在新部署的地方不指定独特的SECRET键，将使用默认值（可能已知），这可能导致安全漏洞。
+
+## default
+
+```
+module.exports = {
+  SECRET: '0xD58F835B69D207A76CC5F84a70a1D0d4C79dAC95',
+}
+```

package/helps/config/accessTokenCookieKey.ja.md

@@ -0,0 +1,11 @@
+# accessTokenCookieKey
+
+ブラウザでクッキーを活用してセッションキーを保存する場合、セッションキーとして活用される固有のクッキーキーを指定することができます。
+
+## default
+
+```
+module.exports = {
+  accessTokenCookieKey: 'access_token',
+}
+```

package/helps/config/accessTokenCookieKey.ko.md

@@ -0,0 +1,11 @@
+# accessTokenCookieKey
+
+브라우저에서 쿠키를 활용해서 세션키를 저장하는 경우, 세션키로 활용될 고유한 쿠키의 키를 지정할 수 있다.
+
+## default
+
+```
+module.exports = {
+  accessTokenCookieKey: 'access_token',
+}
+```

package/helps/config/accessTokenCookieKey.md

@@ -1,6 +1,6 @@
 # accessTokenCookieKey
 
-브라우저에서 쿠키를 활용해서 세션키를 저장하는 경우, 세션키로 활용될 고유한 쿠키의 키를 지정할 수 있다.
+in cases where the session key is stored using cookies in the browser, the unique cookie key to be used as the session key can be specified.
 
 ## default
 

package/helps/config/accessTokenCookieKey.ms.md

@@ -0,0 +1,11 @@
+# accessTokenCookieKey
+
+dalam kes menyimpan kunci sesi menggunakan kuki di pelayar, kunci kuki yang unik boleh ditentukan untuk digunakan sebagai kunci sesi.
+
+## default
+
+```
+module.exports = {
+  accessTokenCookieKey: 'access_token',
+}
+```

package/helps/config/accessTokenCookieKey.zh.md

@@ -0,0 +1,11 @@
+# accessTokenCookieKey
+
+通过在浏览器中使用cookie来存储会话密钥的情况，可以指定用于会话密钥的唯一cookie键。
+
+## default
+
+```
+module.exports = {
+  accessTokenCookieKey: 'access_token',
+}
+```

package/helps/config/applianceJwtExpiresIn.ja.md

@@ -0,0 +1,26 @@
+# applianceJwtExpiresIn
+
+デバイスのアクセストークンの有効期限を設定します。
+
+- 設定値は次のような複数の形式が可能です。[参考](https://github.com/vercel/ms)
+
+```
+2 days // 2日
+1d // 1日
+10h // 10時間
+2.5 hrs // 2.5時間
+2h // 2時間
+1m // 1分
+5s // 5秒
+1y // 1年
+10y // 10年
+100 // 100ミリ秒
+```
+
+## default
+
+```
+module.exports = {
+  applianceJwtExpiresIn: '1y',
+}
+```

package/helps/config/applianceJwtExpiresIn.ko.md

@@ -0,0 +1,26 @@
+# applianceJwtExpiresIn
+
+단말장치의 액세스토큰의 사용 유효기간을 설정한다.
+
+- 설정값은 다음과 같은 여러 형태로 가능합니다.[참조](https://github.com/vercel/ms)
+
+```
+2 days  // 2일
+1d      // 하루
+10h     // 10시간
+2.5 hrs // 2.5시간
+2h      // 2시간
+1m      // 1분
+5s      // 5초
+1y      // 1년
+10y     // 10년
+100     // 100 미리초
+```
+
+## default
+
+```
+module.exports = {
+  applianceJwtExpiresIn: '1y',
+}
+```

package/helps/config/applianceJwtExpiresIn.md

@@ -1,26 +1,29 @@
 # applianceJwtExpiresIn
 
-단말장치의 액세스토큰의 사용 유효기간을 설정한다.
+sets the validity period for the device access token.
 
-- 설정값은 다음과 같은 여러 형태로 가능합니다.[참조](https://github.com/vercel/ms)
+- the setting value can be in various formats as follows.[reference](https://github.com/vercel/ms)
 
-```
-2 days  // 2일
-1d      // 하루
-10h     // 10시간
-2.5 hrs // 2.5시간
-2h      // 2시간
-1m      // 1분
-5s      // 5초
-1y      // 1년
-10y     // 10년
-100     // 100 미리초
+````
+2 days // 2 days
+1d // 1 day
+10h // 10 hours
+2.5 hrs // 2.5 hours
+2h // 2 hours
+1m // 1 minute
+5s // 5 seconds
+1y // 1 year
+10y // 10 years
 ```
 
 ## default
 
-```
+````
+
 module.exports = {
-  applianceJwtExpiresIn: '1y',
+applianceJwtExpiresIn: '1y',
 }
+
+```
+
 ```

package/helps/config/applianceJwtExpiresIn.ms.md

@@ -0,0 +1,30 @@
+# applianceJwtExpiresIn
+
+menetapkan tempoh sah token akses peranti.
+
+- nilai tetapan boleh dalam pelbagai bentuk berikut.[rujukan](https://github.com/vercel/ms)
+
+````
+2 days // 2 hari
+1d // 1 hari
+10h // 10 jam
+2.5 hrs // 2.5 jam
+2h // 2 jam
+1m // 1 minit
+5s // 5 saat
+1y // 1 tahun
+10y // 10 tahun
+100 // 100 milisaat
+```
+
+## default
+
+````
+
+module.exports = {
+applianceJwtExpiresIn: '1y',
+}
+
+```
+
+```

package/helps/config/applianceJwtExpiresIn.zh.md

@@ -0,0 +1,26 @@
+# applianceJwtExpiresIn
+
+设置设备访问令牌的有效期。
+
+- 设置值可以是以下多种形式。[参考](https://github.com/vercel/ms)
+
+```
+2 days // 2天
+1d // 1天
+10h // 10小时
+2.5 hrs // 2.5小时
+2h // 2小时
+1m // 1分钟
+5s // 5秒
+1y // 1年
+10y // 10年
+100 // 100毫秒
+```
+
+## default
+
+```
+module.exports = {
+  applianceJwtExpiresIn: '1y',
+}
+```

package/helps/config/disableUserSignupProcess.ja.md

@@ -0,0 +1,22 @@
+# disableUserSignupProcess
+
+- この設定がtrueの場合、ユーザーはアプリケーションにアクセスしてユーザー登録を申請し、メールを通じてユーザーを検証しアカウントを有効化できます。
+- この設定がfalseの場合、ユーザーは自分でユーザー登録を申請することはできず、システム管理者が新しいユーザーアカウントを登録できます。このとき使用するデフォルトパスワードはpassword設定のdefaultPassword項目に設定できます。
+- この設定は、ユーザー登録、アカウントロック解除の再有効化リクエスト、パスワードを忘れた場合のメールによるパスワードリセットなどのすべてのプロセスに影響を与えます。
+
+## default
+
+```
+module.exports = {
+  password: {
+    ...,
+    defaultPassword: false
+  },
+  /*
+    Only When 'disableUserSignupProcess' is set to false,
+    a user-initiated user registration process is provided.
+    When this value is true, the 'defaultPassword' for the password must be configured.
+  */
+  disableUserSignupProcess: false,
+}
+```

package/helps/config/disableUserSignupProcess.ko.md

@@ -0,0 +1,22 @@
+# disableUserSignupProcess
+
+- 이 설정이 true이면, 사용자가 어플리케이션에 접속해서 사용자 등록을 신청할 수 있으며, 이메일을 통해서 사용자를 검증하고 계정을 활성화할 수 있다.
+- 이 설정이 false이면, 사용자가 직접 사용자 등록 신청을 할 수 없으며, 시스템의 관리자가 신규 사용자 계정을 등록해 줄 수 있다. 이 때에 사용되는 기본 패스워드는 password 설정의 defaultPassword 항목에 설정할 수 있다.
+- 이 설정은 사용자 등록, 계정이 잠김 경우 재 활성화 요청, 패스워드를 기억하지 못하는 경우 이메일을 통한 패스워드 재 설정 등 모든 프로세스에 영향을 미친다.
+
+## default
+
+```
+module.exports = {
+  password: {
+    ...,
+    defaultPassword: false
+  },
+  /*
+    Only When 'disableUserSignupProcess' is set to false,
+    a user-initiated user registration process is provided.
+    When this value is true, the 'defaultPassword' for the password must be configured.
+  */
+  disableUserSignupProcess: false,
+}
+```

package/helps/config/disableUserSignupProcess.md

@@ -1,8 +1,8 @@
 # disableUserSignupProcess
 
-- 이 설정이 true이면, 사용자가 어플리케이션에 접속해서 사용자 등록을 신청할 수 있으며, 이메일을 통해서 사용자를 검증하고 계정을 활성화할 수 있다.
-- 이 설정이 false이면, 사용자가 직접 사용자 등록 신청을 할 수 없으며, 시스템의 관리자가 신규 사용자 계정을 등록해 줄 수 있다. 이 때에 사용되는 기본 패스워드는 password 설정의 defaultPassword 항목에 설정할 수 있다.
-- 이 설정은 사용자 등록, 계정이 잠김 경우 재 활성화 요청, 패스워드를 기억하지 못하는 경우 이메일을 통한 패스워드 재 설정 등 모든 프로세스에 영향을 미친다.
+- if this setting is true, users can access the application and apply for user registration, verify the user through email, and activate the account.
+- if this setting is false, users cannot apply for user registration themselves, and the system administrator can register new user accounts. The default password used at this time can be set in the defaultPassword item of the password settings.
+- this setting affects all processes including user registration, reactivation requests for locked accounts, password resets via email if the password is forgotten, and more.
 
 ## default
 

package/helps/config/disableUserSignupProcess.ms.md

@@ -0,0 +1,22 @@
+# disableUserSignupProcess
+
+- jika tetapan ini adalah true, pengguna boleh mengakses aplikasi dan memohon pendaftaran pengguna, serta mengesahkan pengguna melalui e-mel dan mengaktifkan akaun.
+- jika tetapan ini adalah false, pengguna tidak boleh memohon pendaftaran pengguna sendiri, dan pentadbir sistem boleh mendaftarkan akaun pengguna baru. Kata laluan lalai yang digunakan pada masa ini boleh ditetapkan dalam item defaultPassword dalam tetapan password.
+- tetapan ini mempengaruhi semua proses termasuk pendaftaran pengguna, permintaan pengaktifan semula akaun yang dikunci, menetapkan semula kata laluan melalui e-mel jika terlupa kata laluan, dan sebagainya.
+
+## default
+
+```
+module.exports = {
+  password: {
+    ...,
+    defaultPassword: false
+  },
+  /*
+    Only When 'disableUserSignupProcess' is set to false,
+    a user-initiated user registration process is provided.
+    When this value is true, the 'defaultPassword' for the password must be configured.
+  */
+  disableUserSignupProcess: false,
+}
+```

package/helps/config/disableUserSignupProcess.zh.md

@@ -0,0 +1,22 @@
+# disableUserSignupProcess
+
+- 如果此设置为true，用户可以访问应用程序并申请用户注册，通过电子邮件验证用户并激活帐户。
+- 如果此设置为false，用户无法自行申请用户注册，系统管理员可以注册新用户帐户。此时使用的默认密码可以在password设置的defaultPassword项中进行设置。
+- 此设置影响用户注册、帐户锁定后重新激活请求、忘记密码时通过电子邮件重置密码等所有流程。
+
+## default
+
+```
+module.exports = {
+  password: {
+    ...,
+    defaultPassword: false
+  },
+  /*
+    Only When 'disableUserSignupProcess' is set to false,
+    a user-initiated user registration process is provided.
+    When this value is true, the 'defaultPassword' for the password must be configured.
+  */
+  disableUserSignupProcess: false,
+}
+```

package/helps/config/i18n.ja.md

@@ -0,0 +1,44 @@
+# i18n
+
+- languages
+  - 多言語環境で使用する言語パックを設定できます。
+- defaultLanguage
+  - ユーザーのデフォルト言語設定を指定します。
+  - ユーザーが特に好む言語を指定していない場合、このデフォルト言語設定が使用されます。
+- disableUserFavoredLanguage
+  - ユーザーが好む言語を選択できないように設定できます。
+  - この設定をtrueにすると、ユーザープロフィールメニューに言語選択機能が表示されなくなります。
+  - すべてのユーザーに特定の言語のみを強制したい場合に使用できます。
+
+## default
+
+```
+module.exports = {
+  i18n: {
+    languages: [
+      {
+        code: 'en-US',
+        display: 'English'
+      },
+      {
+        code: 'ko-KR',
+        display: '한국어'
+      },
+      {
+        code: 'zh-CN',
+        display: '中文'
+      },
+      {
+        code: 'ja-JP',
+        display: 'にほんご'
+      },
+      {
+        code: 'ms-MY',
+        display: 'Bahasa Malaysia'
+      }
+    ],
+    defaultLanguage: 'en-US',
+    disableUserFavoredLanguage: false
+  }
+}
+```

package/helps/config/i18n.ko.md

@@ -0,0 +1,44 @@
+# i18n
+
+- languages
+  - 다국어 환경에서 사용하고자 하는 언어팩들을 설정할 수 있다.
+- defaultLanguage
+  - 사용자의 기본 언어 설정을 지정한다.
+  - 사용자가 특별히 선호하는 언어를 지정하지 않은 경우에 이 기본 언어 설정이 사용된다.
+- disableUserFavoredLanguage
+  - 사용자가 선호하는 언어를 선택할 수 없도록 설정할 수 있다.
+  - 이 설정을 true로 하게되면, 사용자 프로필 메뉴에서 언어선택 기능이 보이지 않게된다.
+  - 모든 사용자들이 특정 언어만을 사용하도록 강제하고자 할 때 사용할 수 있다.
+
+## default
+
+```
+module.exports = {
+  i18n: {
+    languages: [
+      {
+        code: 'en-US',
+        display: 'English'
+      },
+      {
+        code: 'ko-KR',
+        display: '한국어'
+      },
+      {
+        code: 'zh-CN',
+        display: '中文'
+      },
+      {
+        code: 'ja-JP',
+        display: 'にほんご'
+      },
+      {
+        code: 'ms-MY',
+        display: 'Bahasa Malaysia'
+      }
+    ],
+    defaultLanguage: 'en-US',
+    disableUserFavoredLanguage: false
+  }
+}
+```

package/helps/config/i18n.md

@@ -1,14 +1,14 @@
 # i18n
 
 - languages
-  - 다국어 환경에서 사용하고자 하는 언어팩들을 설정할 수 있다.
+  - allows setting up the language packs to be used in a multilingual environment.
 - defaultLanguage
-  - 사용자의 기본 언어 설정을 지정한다.
-  - 사용자가 특별히 선호하는 언어를 지정하지 않은 경우에 이 기본 언어 설정이 사용된다.
+  - specifies the user's default language setting.
+  - This default language setting is used when the user has not specified a preferred language.
 - disableUserFavoredLanguage
-  - 사용자가 선호하는 언어를 선택할 수 없도록 설정할 수 있다.
-  - 이 설정을 true로 하게되면, 사용자 프로필 메뉴에서 언어선택 기능이 보이지 않게된다.
-  - 모든 사용자들이 특정 언어만을 사용하도록 강제하고자 할 때 사용할 수 있다.
+  - allows disabling the user's ability to select their preferred language.
+  - Setting this to true will hide the language selection feature in the user profile menu.
+  - Can be used to enforce all users to use a specific language only.
 
 ## default
 

package/helps/config/i18n.ms.md

@@ -0,0 +1,44 @@
+# i18n
+
+- languages
+  - boleh menetapkan pakej bahasa yang ingin digunakan dalam persekitaran pelbagai bahasa.
+- defaultLanguage
+  - Menentukan tetapan bahasa lalai untuk pengguna.
+  - Apabila pengguna tidak memilih bahasa kegemaran khusus, tetapan bahasa lalai ini akan digunakan.
+- disableUserFavoredLanguage
+  - Boleh menetapkan supaya pengguna tidak dapat memilih bahasa kegemaran mereka.
+  - Apabila tetapan ini diaktifkan kepada true, fungsi pilihan bahasa tidak akan dipaparkan dalam menu profil pengguna.
+  - Boleh digunakan apabila ingin memaksa semua pengguna menggunakan bahasa tertentu sahaja.
+
+## default
+
+```
+module.exports = {
+  i18n: {
+    languages: [
+      {
+        code: 'en-US',
+        display: 'English'
+      },
+      {
+        code: 'ko-KR',
+        display: '한국어'
+      },
+      {
+        code: 'zh-CN',
+        display: '中文'
+      },
+      {
+        code: 'ja-JP',
+        display: 'にほんご'
+      },
+      {
+        code: 'ms-MY',
+        display: 'Bahasa Malaysia'
+      }
+    ],
+    defaultLanguage: 'en-US',
+    disableUserFavoredLanguage: false
+  }
+}
+```

package/helps/config/i18n.zh.md

@@ -0,0 +1,44 @@
+# i18n
+
+- languages
+  - 可以设置在多语言环境中使用的语言包。
+- defaultLanguage
+  - 指定用户的默认语言设置。
+  - 当用户没有特别偏好的语言时，将使用此默认语言设置。
+- disableUserFavoredLanguage
+  - 可以设置为无法选择用户偏好的语言。
+  - 将此设置为true时，将在用户个人资料菜单中看不到语言选择功能。
+  - 当希望强制所有用户只使用特定语言时，可以使用此设置。
+
+## default
+
+```
+module.exports = {
+  i18n: {
+    languages: [
+      {
+        code: 'en-US',
+        display: 'English'
+      },
+      {
+        code: 'ko-KR',
+        display: '한국어'
+      },
+      {
+        code: 'zh-CN',
+        display: '中文'
+      },
+      {
+        code: 'ja-JP',
+        display: 'にほんご'
+      },
+      {
+        code: 'ms-MY',
+        display: 'Bahasa Malaysia'
+      }
+    ],
+    defaultLanguage: 'en-US',
+    disableUserFavoredLanguage: false
+  }
+}
+```

package/helps/config/password.ja.md

@@ -0,0 +1,53 @@
+# password
+
+パスワード設定ルールを柔軟に定義し、これらのルールに基づいてパスワードを検証できます。
+
+パスワードルールは、大文字小文字、数字、特殊文字、長さなどのさまざまな要素を調整でき、セキュリティポリシーに合わせてパスワードルールをカスタマイズできます。
+
+- `lowerCase` (デフォルト値: `true`):
+
+  - 小文字を含むかどうかを示すブール値。設定されている場合、パスワードには少なくとも1つの小文字が含まれている必要があります。
+
+- `upperCase` (デフォルト値: `true`):
+
+  - 大文字を含むかどうかを示すブール値。設定されている場合、パスワードには少なくとも1つの大文字が含まれている必要があります。
+
+- `digit` (デフォルト値: `true`):
+
+  - 数字を含むかどうかを示すブール値。設定されている場合、パスワードには少なくとも1つの数字が含まれている必要があります。
+
+- `specialCharacter` (デフォルト値: `true`):
+
+  - 特殊文字を含むかどうかを示すブール値。設定されている場合、パスワードには少なくとも1つの特殊文字(!@#$%^&\*())が含まれている必要があります。
+
+- `allowRepeat` (デフォルト値: `false`):
+
+  - 文字の繰り返しを許可するかどうかを示すブール値。設定されている場合、パスワードに文字が連続して2回以上繰り返されない必要があります。
+
+- `useTightPattern` (デフォルト値: `true`):
+
+  - 厳密なパスワードパターンを使用するかどうかを示すブール値。設定されている場合、パスワードは長さと各要素（小文字、大文字、数字、特殊文字）の要件を厳密に遵守する必要があります。
+
+- `useLoosePattern` (デフォルト値: `false`):
+
+  - 緩やかなパスワードパターンを使用するかどうかを示すブール値。設定されている場合、パスワードの長さのみを厳密にチェックし、
+
+## default
+
+```
+module.exports = {
+  password: {
+    lowerCase: true,
+    upperCase: false,
+    digit: true,
+    specialCharacter: true,
+    allowRepeat: true,
+    useTightPattern: true,
+    useLoosePattern: false,
+    tightCharacterLength: 8,
+    looseCharacterLength: 15,
+    history: 2,
+    defaultPassword: false
+  },
+}
+```