docs: update password hashing parameters (#1560)

lucia-auth · May 1, 2024 · ba7438a · ba7438a
1 parent 30b2264
commit ba7438a
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 42 deletions.
diff --git a/docs/pages/guides/email-and-password/basics.md b/docs/pages/guides/email-and-password/basics.md
@@ -81,9 +81,9 @@ app.post("/signup", async (request: Request) => {
 
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	const userId = generateIdFromEntropySize(10); // 16 characters long
@@ -172,9 +172,9 @@ app.post("/login", async (request: Request) => {
 	}
 
 	const validPassword = await verify(user.password_hash, password, {
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	if (!validPassword) {

diff --git a/docs/pages/guides/email-and-password/password-reset.md b/docs/pages/guides/email-and-password/password-reset.md
@@ -119,9 +119,9 @@ app.post("/reset-password/:token", async () => {
 	await lucia.invalidateUserSessions(token.user_id);
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	await db.table("user").where("id", "=", token.user_id).update({

diff --git a/docs/pages/tutorials/username-and-password/astro.md b/docs/pages/tutorials/username-and-password/astro.md
@@ -106,9 +106,9 @@ export async function POST(context: APIContext): Promise<Response> {
 	const userId = generateIdFromEntropySize(10); // 16 characters long
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 
@@ -205,9 +205,9 @@ export async function POST(context: APIContext): Promise<Response> {
 	}
 
 	const validPassword = await verify(existingUser.password, password, {
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	if (!validPassword) {

diff --git a/docs/pages/tutorials/username-and-password/nextjs-app.md b/docs/pages/tutorials/username-and-password/nextjs-app.md
@@ -118,9 +118,9 @@ async function signup(_: any, formData: FormData): Promise<ActionResult> {
 
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	const userId = generateIdFromEntropySize(10); // 16 characters long
@@ -243,9 +243,9 @@ async function login(_: any, formData: FormData): Promise<ActionResult> {
 	}
 
 	const validPassword = await verify(existingUser.password, password, {
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	if (!validPassword) {

diff --git a/docs/pages/tutorials/username-and-password/nextjs-pages.md b/docs/pages/tutorials/username-and-password/nextjs-pages.md
@@ -135,9 +135,9 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
 
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	const userId = generateIdFromEntropySize(10); // 16 characters long
@@ -266,9 +266,9 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
 	}
 
 	const validPassword = await verify(existingUser.password, password, {
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	if (!validPassword) {

diff --git a/docs/pages/tutorials/username-and-password/nuxt.md b/docs/pages/tutorials/username-and-password/nuxt.md
@@ -115,9 +115,9 @@ export default eventHandler(async (event) => {
 
 	const passwordHash = await hash(password, {
 		// recommended minimum parameters
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	const userId = generateIdFromEntropySize(10); // 16 characters long
@@ -222,9 +222,9 @@ export default eventHandler(async (event) => {
 	}
 
 	const validPassword = await verify(existingUser.password, password, {
-		memorySize: 19456,
-		iterations: 2,
-		tagLength: 32,
+		memoryCost: 19456,
+		timeCost: 2,
+		outputLen: 32,
 		parallelism: 1
 	});
 	if (!validPassword) {

diff --git a/docs/pages/tutorials/username-and-password/sveltekit.md b/docs/pages/tutorials/username-and-password/sveltekit.md
@@ -111,9 +111,9 @@ export const actions: Actions = {
 		const userId = generateIdFromEntropySize(10); // 16 characters long
 		const passwordHash = await hash(password, {
 			// recommended minimum parameters
-			memorySize: 19456,
-			iterations: 2,
-			tagLength: 32,
+			memoryCost: 19456,
+			timeCost: 2,
+			outputLen: 32,
 			parallelism: 1
 		});
 
@@ -217,9 +217,9 @@ export const actions: Actions = {
 		}
 
 		const validPassword = await verify(existingUser.password_hash, password, {
-			memorySize: 19456,
-			iterations: 2,
-			tagLength: 32,
+			memoryCost: 19456,
+			timeCost: 2,
+			outputLen: 32,
 			parallelism: 1
 		});
 		if (!validPassword) {

diff --git a/docs/pages/upgrade-v3/index.md b/docs/pages/upgrade-v3/index.md
@@ -17,9 +17,9 @@ For a simple password-based auth, the password can just be stored in the user ta
 ```ts
 const passwordHash = await hash(password, {
 	// recommended minimum parameters
-	memorySize: 19456,
-	iterations: 2,
-	tagLength: 32,
+	memoryCost: 19456,
+	timeCost: 2,
+	outputLen: 32,
 	parallelism: 1
 });
 const userId = generateIdFromEntropySize(10); // 16 characters long