From 9e65ab5ff9492aac02b3bae7291b22dae9ed1148 Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Mon, 7 Oct 2024 17:54:22 +0100 Subject: [PATCH 1/3] implemented create user with scrypt --- src/PinguApps.Appwrite.Playground/App.cs | 11 ++++++++--- .../Clients/IUsersClient.cs | 8 +++++++- .../Clients/UsersClient.cs | 17 +++++++++++++++-- 3 files changed, 30 insertions(+), 6 deletions(-) diff --git a/src/PinguApps.Appwrite.Playground/App.cs b/src/PinguApps.Appwrite.Playground/App.cs index 5545aaa3..5194cb24 100644 --- a/src/PinguApps.Appwrite.Playground/App.cs +++ b/src/PinguApps.Appwrite.Playground/App.cs @@ -17,13 +17,18 @@ public App(Client.IAppwriteClient client, Server.Clients.IAppwriteClient server, public async Task Run(string[] args) { - var request = new CreateUserWithPhpassPasswordRequest() + var request = new CreateUserWithScryptPasswordRequest() { Email = "pingu@example.com", - Password = "$P$5ZDzPE45Ci.QxPaPz.03z6TYbakcSQ0" + Password = "dbb97714c09bad417bb51288abd2c049c557e5e617839a7bc8c615492db859b57624366de72f04b9d4c3e6452a497a67a36f1afcc481d6d69f6da9e5f03598d7", + PasswordSalt = "MySuperSalt", + PasswordCpu = 16384, + PasswordMemory = 8, + PasswordParallel = 1, + PasswordLength = 64 }; - var response = await _server.Users.CreateUserWithPhpassPassword(request); + var response = await _server.Users.CreateUserWithScryptPassword(request); Console.WriteLine(response.Result.Match( result => result.ToString(), diff --git a/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs b/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs index 475fe6ef..57589562 100644 --- a/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs @@ -76,7 +76,13 @@ public interface IUsersClient /// The request content /// The user Task> CreateUserWithPhpassPassword(CreateUserWithPhpassPasswordRequest request); - [Obsolete("This method hasn't yet been implemented.", true)] + + /// + /// Create a new user. Password provided must be hashed with the Scrypt algorithm. Use to create users with a plain text password. + /// Appwrite Docs + /// + /// The request content + /// The user Task> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request); [Obsolete("This method hasn't yet been implemented.", true)] Task> CreateUserWithScryptModifiedPassword(CreateUserWithScryptModifiedPasswordRequest request); diff --git a/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs b/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs index b75a4e44..e2b2c5b8 100644 --- a/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs +++ b/src/PinguApps.Appwrite.Server/Clients/UsersClient.cs @@ -162,9 +162,22 @@ public async Task> CreateUserWithPhpassPassword(CreateUserW } } - [ExcludeFromCodeCoverage] /// - public Task> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request) => throw new NotImplementedException(); + public async Task> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request) + { + try + { + request.Validate(true); + + var result = await _usersApi.CreateUserWithScryptPassword(request); + + return result.GetApiResponse(); + } + catch (Exception e) + { + return e.GetExceptionResponse(); + } + } [ExcludeFromCodeCoverage] /// From 7bd6e5aa6e3ba03b91e957e8fd791552387abdde Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Mon, 7 Oct 2024 17:58:12 +0100 Subject: [PATCH 2/3] added tests for create user with scrypt password --- ...lientTests.CreateUserWithScryptPassword.cs | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithScryptPassword.cs diff --git a/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithScryptPassword.cs b/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithScryptPassword.cs new file mode 100644 index 00000000..70ee5747 --- /dev/null +++ b/tests/PinguApps.Appwrite.Server.Tests/Clients/Users/UsersClientTests.CreateUserWithScryptPassword.cs @@ -0,0 +1,80 @@ +using System.Net; +using PinguApps.Appwrite.Shared.Requests.Users; +using PinguApps.Appwrite.Shared.Tests; +using RichardSzalay.MockHttp; + +namespace PinguApps.Appwrite.Server.Tests.Clients.Users; +public partial class UsersClientTests +{ + [Fact] + public async Task CreateUserWithScryptPassword_ShouldReturnSuccess_WhenApiCallSucceeds() + { + // Arrange + var request = new CreateUserWithScryptPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordSalt = "MySalt" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/scrypt") + .WithJsonContent(request) + .ExpectedHeaders() + .Respond(Constants.AppJson, Constants.UserResponse); + + // Act + var result = await _appwriteClient.Users.CreateUserWithScryptPassword(request); + + // Assert + Assert.True(result.Success); + } + + [Fact] + public async Task CreateUserWithScryptPassword_ShouldHandleException_WhenApiCallFails() + { + // Arrange + var request = new CreateUserWithScryptPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordSalt = "MySalt" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/scrypt") + .WithJsonContent(request) + .ExpectedHeaders() + .Respond(HttpStatusCode.BadRequest, Constants.AppJson, Constants.AppwriteError); + + // Act + var result = await _appwriteClient.Users.CreateUserWithScryptPassword(request); + + // Assert + Assert.True(result.IsError); + Assert.True(result.IsAppwriteError); + } + + [Fact] + public async Task CreateUserWithScryptPassword_ShouldReturnErrorResponse_WhenExceptionOccurs() + { + // Arrange + var request = new CreateUserWithScryptPasswordRequest + { + Email = "test@example.com", + Password = "password123", + PasswordSalt = "MySalt" + }; + + _mockHttp.Expect(HttpMethod.Post, $"{Constants.Endpoint}/users/scrypt") + .WithJsonContent(request) + .ExpectedHeaders() + .Throw(new HttpRequestException("An error occurred")); + + // Act + var result = await _appwriteClient.Users.CreateUserWithScryptPassword(request); + + // Assert + Assert.False(result.Success); + Assert.True(result.IsInternalError); + Assert.Equal("An error occurred", result.Result.AsT2.Message); + } +} From 6ea6d346fe12a8c14786df43285037fc50b2df5b Mon Sep 17 00:00:00 2001 From: Matthew Parker Date: Mon, 7 Oct 2024 17:59:03 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5b791018..948eb2e9 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,9 @@ string emailAddressOrErrorMessage = userResponse.Result.Match( ``` ## ⌛ Progress -![Server & Client - 63 / 291](https://img.shields.io/badge/Server_&_Client-63%20%2F%20291-red?style=for-the-badge) +![Server & Client - 64 / 291](https://img.shields.io/badge/Server_&_Client-64%20%2F%20291-red?style=for-the-badge) -![Server - 19 / 201](https://img.shields.io/badge/Server-19%20%2F%20201-red?style=for-the-badge) +![Server - 20 / 201](https://img.shields.io/badge/Server-20%20%2F%20201-red?style=for-the-badge) ![Client - 44 / 90](https://img.shields.io/badge/Client-44%20%2F%2090-gold?style=for-the-badge) @@ -205,7 +205,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match( | [Create Phone Verification (Confirmation)](https://appwrite.io/docs/references/1.6.x/client-rest/account#updatePhoneVerification) | ✅ | ❌ | | ### Users -![Account - 8 / 41](https://img.shields.io/badge/Users-8%20%2F%2041-red?style=for-the-badge) +![Account - 9 / 41](https://img.shields.io/badge/Users-9%20%2F%2041-red?style=for-the-badge) | Endpoint | Client | Server | |:-:|:-:|:-:| @@ -217,7 +217,7 @@ string emailAddressOrErrorMessage = userResponse.Result.Match( | [Delete Identity](https://appwrite.io/docs/references/1.6.x/server-rest/users#deleteIdentity) | ❌ | ✅ | | [Create User with MD5 Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createMD5User) | ❌ | ✅ | | [Create User with PHPass Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createPHPassUser) | ❌ | ✅ | -| [Create User with Scrypt Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptUser) | ❌ | ⬛ | +| [Create User with Scrypt Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptUser) | ❌ | ✅ | | [Create User with Scrypt Modified Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptModifiedUser) | ❌ | ⬛ | | [Create User with SHA Password](https://appwrite.io/docs/references/1.6.x/server-rest/users#createSHAUser) | ❌ | ⬛ | | [Get User](https://appwrite.io/docs/references/1.6.x/server-rest/users#get) | ❌ | ⬛ |