Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented create user with scrypt password #239

Merged
merged 3 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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 |
|:-:|:-:|:-:|
Expand All @@ -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) | ❌ | ⬛ |
Expand Down
11 changes: 8 additions & 3 deletions src/PinguApps.Appwrite.Playground/App.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "[email protected]",
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(),
Expand Down
8 changes: 7 additions & 1 deletion src/PinguApps.Appwrite.Server/Clients/IUsersClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,13 @@ public interface IUsersClient
/// <param name="request">The request content</param>
/// <returns>The user</returns>
Task<AppwriteResult<User>> CreateUserWithPhpassPassword(CreateUserWithPhpassPasswordRequest request);
[Obsolete("This method hasn't yet been implemented.", true)]

/// <summary>
/// Create a new user. Password provided must be hashed with the <see href="https://github.com/Tarsnap/scrypt">Scrypt</see> algorithm. Use <see cref="CreateUser(CreateUserRequest)"/> to create users with a plain text password.
/// <para><see href="https://appwrite.io/docs/references/1.6.x/server-rest/users#createScryptUser">Appwrite Docs</see></para>
/// </summary>
/// <param name="request">The request content</param>
/// <returns>The user</returns>
Task<AppwriteResult<User>> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request);
[Obsolete("This method hasn't yet been implemented.", true)]
Task<AppwriteResult<User>> CreateUserWithScryptModifiedPassword(CreateUserWithScryptModifiedPasswordRequest request);
Expand Down
17 changes: 15 additions & 2 deletions src/PinguApps.Appwrite.Server/Clients/UsersClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,22 @@ public async Task<AppwriteResult<User>> CreateUserWithPhpassPassword(CreateUserW
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
public Task<AppwriteResult<User>> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request) => throw new NotImplementedException();
public async Task<AppwriteResult<User>> CreateUserWithScryptPassword(CreateUserWithScryptPasswordRequest request)
{
try
{
request.Validate(true);

var result = await _usersApi.CreateUserWithScryptPassword(request);

return result.GetApiResponse();
}
catch (Exception e)
{
return e.GetExceptionResponse<User>();
}
}

[ExcludeFromCodeCoverage]
/// <inheritdoc/>
Expand Down
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]",
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 = "[email protected]",
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 = "[email protected]",
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);
}
}