@twin.org/api-auth-entity-storage-service 0.0.3-next.8 → 0.9.0-next.1

package/docs/reference/interfaces/IEntityStorageAuthenticationRateServiceConstructorOptions.md

@@ -0,0 +1,53 @@
+# Interface: IEntityStorageAuthenticationRateServiceConstructorOptions
+
+Options for the EntityStorageAuthenticationRateService constructor.
+
+## Properties
+
+### authenticationRateEntryStorageType? {#authenticationrateentrystoragetype}
+
+> `optional` **authenticationRateEntryStorageType?**: `string`
+
+The entity storage for authentication rate entries.
+
+#### Default
+
+```ts
+authentication-rate-entry
+```
+
+***
+
+### taskSchedulerComponentType? {#taskschedulercomponenttype}
+
+> `optional` **taskSchedulerComponentType?**: `string`
+
+The task scheduler component type.
+
+#### Default
+
+```ts
+task-scheduler
+```
+
+***
+
+### platformComponentType? {#platformcomponenttype}
+
+> `optional` **platformComponentType?**: `string`
+
+The platform component type, used to run the periodic cleanup per tenant.
+
+#### Default
+
+```ts
+platform
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IEntityStorageAuthenticationRateServiceConfig`](IEntityStorageAuthenticationRateServiceConfig.md)
+
+The configuration for the authentication rate service.

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConfig.md

@@ -4,9 +4,9 @@ Configuration for the entity storage authentication service.
 
 ## Properties
 
-### signingKeyName?
+### signingKeyName? {#signingkeyname}
 
-> `optional` **signingKeyName**: `string`
+> `optional` **signingKeyName?**: `string`
 
 The name of the key to retrieve from the vault for signing JWT.
 
@@ -18,14 +18,70 @@ auth-signing
 
 ***
 
-### defaultTtlMinutes?
+### defaultTtlMinutes? {#defaultttlminutes}
 
-> `optional` **defaultTtlMinutes**: `number`
+> `optional` **defaultTtlMinutes?**: `number`
 
 The default time to live for the JWT.
 
 #### Default
 
 ```ts
-1440
+60
+```
+
+***
+
+### minPasswordLength? {#minpasswordlength}
+
+> `optional` **minPasswordLength?**: `number`
+
+The minimum password length for new password validation.
+
+#### Default
+
+```ts
+8
+```
+
+***
+
+### loginRateLimit? {#loginratelimit}
+
+> `optional` **loginRateLimit?**: `IAuthenticationRateActionConfig`
+
+Optional override for login failure rate limit.
+
+#### Default
+
+```ts
+{ maxAttempts: 5, windowMinutes: 15 }
+```
+
+***
+
+### passwordChangeRateLimit? {#passwordchangeratelimit}
+
+> `optional` **passwordChangeRateLimit?**: `IAuthenticationRateActionConfig`
+
+Optional override for password change rate limit.
+
+#### Default
+
+```ts
+{ maxAttempts: 5, windowMinutes: 15 }
+```
+
+***
+
+### tokenRefreshRateLimit? {#tokenrefreshratelimit}
+
+> `optional` **tokenRefreshRateLimit?**: `IAuthenticationRateActionConfig`
+
+Optional override for token refresh rate limit.
+
+#### Default
+
+```ts
+{ maxAttempts: 30, windowMinutes: 60 }
 ```

package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the EntityStorageAuthenticationService constructor.
 
 ## Properties
 
-### userEntityStorageType?
+### userEntityStorageType? {#userentitystoragetype}
 
-> `optional` **userEntityStorageType**: `string`
+> `optional` **userEntityStorageType?**: `string`
 
 The entity storage for the users.
 
@@ -18,9 +18,9 @@ authentication-user
 
 ***
 
-### vaultConnectorType?
+### vaultConnectorType? {#vaultconnectortype}
 
-> `optional` **vaultConnectorType**: `string`
+> `optional` **vaultConnectorType?**: `string`
 
 The vault for the private keys.
 
@@ -32,22 +32,50 @@ vault
 
 ***
 
-### authenticationAdminServiceType?
+### authenticationAuditServiceType? {#authenticationauditservicetype}
 
-> `optional` **authenticationAdminServiceType**: `string`
+> `optional` **authenticationAuditServiceType?**: `string`
 
-The admin service.
+The audit service.
 
 #### Default
 
 ```ts
-authentication-admin
+authentication-audit
 ```
 
 ***
 
-### config?
+### authenticationRateServiceType? {#authenticationrateservicetype}
 
-> `optional` **config**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
+> `optional` **authenticationRateServiceType?**: `string`
+
+The rate service.
+
+#### Default
+
+```ts
+authentication-rate
+```
+
+***
+
+### tenantAdminComponentType? {#tenantadmincomponenttype}
+
+> `optional` **tenantAdminComponentType?**: `string`
+
+The component to retrieve tenant information.
+
+#### Default
+
+```ts
+tenant-admin
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IEntityStorageAuthenticationServiceConfig`](IEntityStorageAuthenticationServiceConfig.md)
 
 The configuration for the authentication.

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,5 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+REST entry points for the authentication, authentication admin, and authentication audit services.

package/docs/reference/variables/tagsAuthenticationAdmin.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuthenticationAdmin
+
+> `const` **tagsAuthenticationAdmin**: `ITag`[]
+
+The tag to associate with the routes.

package/docs/reference/variables/tagsAuthenticationAudit.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuthenticationAudit
+
+> `const` **tagsAuthenticationAudit**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -3,25 +3,42 @@
 		"entityStorageAuthenticationService": {
 			"loginFailed": "Login failed",
 			"userNotFound": "The user with the specified e-mail could not be found",
-			"passwordMismatch": "The password does not match the user's password"
+			"passwordMismatch": "The password does not match the user's password",
+			"nodeIdNotSet": "The node ID has not been set"
 		},
 		"entityStorageAuthenticationAdminService": {
 			"userExists": "The user with the specified e-mail already exists",
 			"createUserFailed": "Creating the user failed",
+			"getUserFailed": "Getting the user failed",
+			"updateUserFailed": "Updating the user failed",
 			"removeUserFailed": "Removing the user failed",
 			"updatePasswordFailed": "Updating the user's password failed",
-			"passwordTooShort": "The password is too short, it must be at least {minLength} characters long",
-			"userNotFound": "The user with the specified e-mail could not be found \"{notFoundId}\"",
+			"userNotFound": "The user with the specified e-mail could not be found \"{notFoundId}\""
+		},
+		"authHeaderProcessor": {
+			"nodeIdNotSet": "The node ID has not been set"
+		},
+		"passwordHelper": {
 			"currentPasswordMismatch": "The current password is incorrect"
 		},
+		"entityStorageAuthenticationRateService": {
+			"actionConfigMissing": "No rate-limit configuration exists for action \"{action}\".",
+			"rateLimitExceeded": "The rate limit for action \"{action}\" has been exceeded. Retry after {retryAfterSeconds} seconds."
+		},
 		"tokenHelper": {
 			"missing": "The JSON Web token could not be found in the authorization header",
+			"headerKeyIdMismatch": "The JSON Web token key identifier does not match the expected signing key",
+			"payloadIssuerMismatch": "The JSON Web token issuer does not match the expected signing key",
 			"payloadMissingSubject": "The JSON Web token payload does not contain a subject",
 			"payloadMissingOrganization": "The JSON Web token payload does not contain an organization",
-			"expired": "The JSON Web token has expired"
+			"expired": "The JSON Web token has expired",
+			"insufficientScopes": "The JSON Web token does not have the required scopes to access this resource",
+			"userNotVerified": "The user associated with the JSON Web token could not be verified",
+			"organizationNotVerified": "The organization associated with the JSON Web token could not be verified",
+			"tenantNotVerified": "The tenant associated with the JSON Web token could not be verified"
 		},
-		"authHeaderProcessor": {
-			"tenantIdMismatch": "The tenant ID in the token does not match the tenant ID in the context"
+		"validation": {
+			"saltEntropyTooLow": "Salt must have at least 8 unique characters for sufficient entropy."
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/api-auth-entity-storage-service",
-	"version": "0.0.3-next.8",
-	"description": "Auth Entity Storage contract implementation and REST endpoint definitions",
+	"version": "0.9.0-next.1",
+	"description": "Authentication service implementation and REST routes backed by entity storage.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/api.git",
+		"url": "git+https://github.com/iotaledger/twin-api.git",
 		"directory": "packages/api-auth-entity-storage-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,18 +14,19 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-auth-entity-storage-models": "0.0.3-next.8",
-		"@twin.org/api-core": "0.0.3-next.8",
-		"@twin.org/api-models": "0.0.3-next.8",
-		"@twin.org/context": "next",
-		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/logging-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/web": "next"
+		"@twin.org/api-auth-entity-storage-models": "0.9.0-next.1",
+		"@twin.org/api-core": "0.9.0-next.1",
+		"@twin.org/api-models": "0.9.0-next.1",
+		"@twin.org/background-task-models": "0.0.3-next.13",
+		"@twin.org/context": "0.9.0-next.1",
+		"@twin.org/core": "0.9.0-next.1",
+		"@twin.org/crypto": "0.9.0-next.1",
+		"@twin.org/entity": "0.9.0-next.1",
+		"@twin.org/entity-storage-models": "0.0.3-next.33",
+		"@twin.org/logging-models": "0.0.3-next.8",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"@twin.org/vault-models": "0.0.3-next.9",
+		"@twin.org/web": "0.9.0-next.1"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -58,7 +59,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/api/issues"
+		"url": "git+https://github.com/iotaledger/twin-api/issues"
 	},
 	"homepage": "https://twindev.org"
 }