Merge pull request #25 from passbolt/update-dep

update deps

.github/workflows/.go.yml

@@ -13,17 +13,17 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: 1.17
+          go-version: 1.23
       - name: "Setup Passbolt"
         run: |
             git clone https://github.com/passbolt/passbolt_docker.git ../passbolt_docker
             cd ../passbolt_docker
-            docker-compose up -d
+            docker compose -f docker-compose/docker-compose-ce.yaml up -d
             docker ps -a
       - name: "Test"
         run: |
-            docker exec passbolt_docker_passbolt_1 sh -c '/usr/bin/wait-for.sh -t 30 localhost:443'
-            output=$(docker exec passbolt_docker_passbolt_1 sh -c 'su -m -c "/usr/share/php/passbolt/bin/cake \
+            docker exec docker-compose-passbolt-1 sh -c '/usr/bin/wait-for.sh -t 30 localhost:443'
+            output=$(docker exec docker-compose-passbolt-1 sh -c 'su -m -c "/usr/share/php/passbolt/bin/cake \
               passbolt register_user \
               -u your@email.com \
               -f yourname \

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 speatzle
+Copyright (c) 2021 Samuel Lorch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,10 @@
 # go-passbolt
-[![Go Reference](https://pkg.go.dev/badge/github.com/speatzle/go-passbolt.svg)](https://pkg.go.dev/github.com/speatzle/go-passbolt)
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/passbolt/go-passbolt.svg)](https://pkg.go.dev/github.com/passbolt/go-passbolt)
 
 A Go module to interact with [Passbolt](https://www.passbolt.com/), an open-source password manager for teams
 
-There also is a CLI Tool to interact with Passbolt using this module [here](https://github.com/speatzle/go-passbolt-cli).
+There also is a CLI Tool to interact with Passbolt using this module [here](https://github.com/passbolt/go-passbolt-cli).
 
 This module tries to support the latest Passbolt Community/PRO server release, PRO Features such as folders are supported. Older versions of Passbolt such as v2 are unsupported (it's a password manager, please update it)
 
@@ -15,16 +16,16 @@ The helper package has simplified functions that use the API package to perform
 
 To use the API package, please read the [Passbolt API docs](https://help.passbolt.com/api). Sadly the docs aren't complete so many things here have been found by looking at the source of Passbolt or through trial and error. If you have a question just ask.
 
-PR's are welcome. But be gentle: if it's something bigger or fundamental: please [create an issue](https://github.com/speatzle/go-passbolt/issues/new) and ask first.
+PR's are welcome. But be gentle: if it's something bigger or fundamental: please [create an issue](https://github.com/passbolt/go-passbolt/issues/new) and ask first.
 
 Disclaimer: This project is community driven and not associated with Passbolt SA
 
-
 # Install
 
-`go get github.com/speatzle/go-passbolt`
+`go get github.com/passbolt/go-passbolt`
 
 # Examples
+
 ## Login
 
 First, you will need to create a client and then log in on the server using the client:
@@ -36,7 +37,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 const address = "https://passbolt.example.com"
@@ -70,7 +71,7 @@ You can do this using the `client.CheckSession()` function.
 
 ## Create a Resource
 
-Creating a resource using the helper package is simple. First, add `"github.com/speatzle/go-passbolt/helper"` to your imports.
+Creating a resource using the helper package is simple. First, add `"github.com/passbolt/go-passbolt/helper"` to your imports.
 
 Then you can simply:
 
@@ -214,6 +215,7 @@ err = helper.UpdateUser(
 	"lastname",  // LastName
 )
 ```
+
 Note: These helpers will only update fields that are not "".
 
 Helper update functions also exists for Folders.
@@ -226,11 +228,11 @@ During sharing you will encounter the [permission type](https://github.com/passb
 
 The `permissionType` can be:
 
-| Code | Meaning | 
-| --- | --- | 
-| `1` | "Read-only" | 
-| `7` | "Can update" | 
-| `15` | "Owner" |
+| Code | Meaning                    |
+| ---- | -------------------------- |
+| `1`  | "Read-only"                |
+| `7`  | "Can update"               |
+| `15` | "Owner"                    |
 | `-1` | Delete existing permission |
 
 The `ShareResourceWithUsersAndGroups` function shares the resource with all provided users and groups with the given `permissionType`.
@@ -294,6 +296,7 @@ err := client.MoveFolder(ctx, "folder id", "parent folder id")
 ## Setup
 
 You can setup a Account using a Invite Link like this:
+
 ```go
 // Get the UserID and Token from the Invite Link
 userID, token, err := ParseInviteUrl(url)
@@ -305,10 +308,33 @@ rClient, err := api.NewClient(nil, "", "https://localhost", "", "")
 privkey, err := SetupAccount(ctx, rClient, userID, token, "password123")
 ```
 
+## Verification
+
+You can Verify that the Server hasen't changed, for that you need to initially setup the Verification and save the returned values. Then you can Verify that the serverkey hasen't changed since you setup the Verification. Note this Only Works if the client is not logged in.
+
+```go
+// Setup the Verification
+token, encToken, err := client.SetupServerVerification(ctx)
+if err != nil {
+	panic(err)
+}
+// You Need to save these
+fmt.Println("Token: ", token)
+fmt.Println("enc Token: ", encToken)
+// Now you can Verify the Server
+err = client.VerifyServer(ctx, token, encToken)
+if err != nil {
+	panic(err)
+}
+```
+
+## MFA
+
+go-passbolt now supports MFA! You can set it up using the Client's `MFACallback` function, it will provide everything you need to complete any MFA challenges. When your done you just need to return the new MFA Cookie (usually called passbolt_mfa). The helper package has a example implementation for a noninteractive TOTP Setup under helper/mfa.go in the function `AddMFACallbackTOTP`.
+
 ## Other
 
-These examples are just the main use cases of these Modules, many more API calls are supported. Look at the [reference](https://pkg.go.dev/github.com/speatzle/go-passbolt) for more information.
-
+These examples are just the main use cases of these Modules, many more API calls are supported. Look at the [reference](https://pkg.go.dev/github.com/passbolt/go-passbolt) for more information.
 
 ## Full Example
 
@@ -326,8 +352,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
-	"github.com/speatzle/go-passbolt/helper"
+	"github.com/passbolt/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/helper"
 )
 
 const address = "https://passbolt.example.com"

api/api.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"strings"
 )
 
 // APIResponse is the Struct representation of a Json Response
@@ -32,9 +33,11 @@ func (c *Client) DoCustomRequest(ctx context.Context, method, path, version stri
 
 // DoCustomRequestAndReturnRawResponse Executes a Custom Request and returns a APIResponse and the Raw HTTP Response
 func (c *Client) DoCustomRequestAndReturnRawResponse(ctx context.Context, method, path, version string, body interface{}, opts interface{}) (*http.Response, *APIResponse, error) {
-	u, err := addOptions(path, version, opts)
+	firstTime := true
+start:
+	u, err := generateURL(*c.baseURL, path, version, opts)
 	if err != nil {
-		return nil, nil, fmt.Errorf("Adding Request Options: %w", err)
+		return nil, nil, fmt.Errorf("Generating Path: %w", err)
 	}
 
 	req, err := c.newRequest(method, u, body)
@@ -48,9 +51,35 @@ func (c *Client) DoCustomRequestAndReturnRawResponse(ctx context.Context, method
 		return r, &res, fmt.Errorf("Doing Request: %w", err)
 	}
 
+	// Because of MFA i need to do the csrf token stuff here
+	if c.csrfToken.Name == "" {
+		for _, cookie := range r.Cookies() {
+			if cookie.Name == "csrfToken" {
+				c.csrfToken = *cookie
+			}
+		}
+	}
+
 	if res.Header.Status == "success" {
 		return r, &res, nil
 	} else if res.Header.Status == "error" {
+		if res.Header.Code == 403 && strings.HasSuffix(res.Header.URL, "/mfa/verify/error.json") {
+			if !firstTime {
+				// if we are here this probably means that the MFA callback is broken, to prevent a infinite loop lets error here
+				return r, &res, fmt.Errorf("Got MFA challenge twice in a row, is your MFA Callback broken? Bailing to prevent loop...:")
+			}
+			if c.MFACallback != nil {
+				c.mfaToken, err = c.MFACallback(ctx, c, &res)
+				if err != nil {
+					return r, &res, fmt.Errorf("MFA Callback: %w", err)
+				}
+				// ok, we got the MFA challenge and the callback presumably handled it so we can retry the original request
+				firstTime = false
+				goto start
+			} else {
+				return r, &res, fmt.Errorf("Got MFA Challenge but the MFA callback is not defined")
+			}
+		}
 		return r, &res, fmt.Errorf("%w: Message: %v, Body: %v", ErrAPIResponseErrorStatusCode, res.Header.Message, string(res.Body))
 	} else {
 		return r, &res, fmt.Errorf("%w: Message: %v, Body: %v", ErrAPIResponseUnknownStatusCode, res.Header.Message, string(res.Body))

api/auth.go

@@ -6,19 +6,12 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
-	"strconv"
 	"strings"
 
 	"github.com/ProtonMail/gopenpgp/v2/crypto"
 	"github.com/ProtonMail/gopenpgp/v2/helper"
 )
 
-// PublicKeyReponse the Body of a Public Key Api Request
-type PublicKeyReponse struct {
-	Fingerprint string `json:"fingerprint"`
-	Keydata     string `json:"keydata"`
-}
-
 // Login is used for login
 type Login struct {
 	Auth *GPGAuth `json:"gpg_auth"`
@@ -30,24 +23,6 @@ type GPGAuth struct {
 	Token string `json:"user_token_result,omitempty"`
 }
 
-// TODO add Server Verification Function
-
-// GetPublicKey gets the Public Key and Fingerprint of the Passbolt instance
-func (c *Client) GetPublicKey(ctx context.Context) (string, string, error) {
-	msg, err := c.DoCustomRequest(ctx, "GET", "auth/verify.json", "v2", nil, nil)
-	if err != nil {
-		return "", "", fmt.Errorf("Doing Request: %w", err)
-	}
-
-	var body PublicKeyReponse
-	err = json.Unmarshal(msg.Body, &body)
-	if err != nil {
-		return "", "", fmt.Errorf("Parsing JSON: %w", err)
-	}
-	// TODO check if that Fingerpirnt is actually from the Publickey
-	return body.Keydata, body.Fingerprint, nil
-}
-
 // CheckSession Check to see if you have a Valid Session
 func (c *Client) CheckSession(ctx context.Context) bool {
 	_, err := c.DoCustomRequest(ctx, "GET", "auth/is-authenticated.json", "v2", nil, nil)
@@ -56,6 +31,7 @@ func (c *Client) CheckSession(ctx context.Context) bool {
 
 // Login gets a Session and CSRF Token from Passbolt and Stores them in the Clients Cookie Jar
 func (c *Client) Login(ctx context.Context) error {
+	c.csrfToken = http.Cookie{}
 
 	if c.userPrivateKey == "" {
 		return fmt.Errorf("Client has no Private Key")
@@ -113,31 +89,21 @@ func (c *Client) Login(ctx context.Context) error {
 			// Session Cookie in older Passbolt Versions
 		} else if cookie.Name == "CAKEPHP" {
 			c.sessionToken = *cookie
+			// Session Cookie in Cloud version?
+		} else if cookie.Name == "PHPSESSID" {
+			c.sessionToken = *cookie
 		}
 	}
 	if c.sessionToken.Name == "" {
 		return fmt.Errorf("Cannot Find Session Cookie!")
 	}
 
-	// Do Mfa Here if ever
-
-	// You have to get a make GET Request to get the CSRF Token which is Required for Write Operations
-	msg, apiMsg, err := c.DoCustomRequestAndReturnRawResponse(ctx, "GET", "/users/me.json", "v2", nil, nil)
+	// Because of MFA, the custom Request Function now Fetches the CSRF token, we still need the user for his public key
+	apiMsg, err := c.DoCustomRequest(ctx, "GET", "/users/me.json", "v2", nil, nil)
 	if err != nil {
-		c.log("is MFA Enabled? That is not yet Supported!")
 		return fmt.Errorf("Getting CSRF Token: %w", err)
 	}
 
-	for _, cookie := range msg.Cookies() {
-		if cookie.Name == "csrfToken" {
-			c.csrfToken = *cookie
-		}
-	}
-
-	if c.csrfToken.Name == "" {
-		return fmt.Errorf("Cannot Find csrfToken Cookie!")
-	}
-
 	// Get Users Own Public Key from Server
 	var user User
 	err = json.Unmarshal(apiMsg.Body, &user)
@@ -176,33 +142,3 @@ func (c *Client) Logout(ctx context.Context) error {
 	c.csrfToken = http.Cookie{}
 	return nil
 }
-
-// GetUserID Gets the ID of the Current User
-func (c *Client) GetUserID() string {
-	return c.userID
-}
-
-func checkAuthTokenFormat(authToken string) error {
-	splitAuthToken := strings.Split(authToken, "|")
-	if len(splitAuthToken) != 4 {
-		return fmt.Errorf("Auth Token Has Wrong amount of Fields")
-	}
-
-	if splitAuthToken[0] != splitAuthToken[3] {
-		return fmt.Errorf("Auth Token Version Fields Don't match")
-	}
-
-	if !strings.HasPrefix(splitAuthToken[0], "gpgauth") {
-		return fmt.Errorf("Auth Token Version does not start with 'gpgauth'")
-	}
-
-	length, err := strconv.Atoi(splitAuthToken[1])
-	if err != nil {
-		return fmt.Errorf("Cannot Convert Auth Token Length Field to int: %w", err)
-	}
-
-	if len(splitAuthToken[2]) != length {
-		return fmt.Errorf("Auth Token Data Length does not Match Length Field")
-	}
-	return nil
-}

api/client.go

@@ -9,6 +9,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"net/url"
+	"path"
 
 	"github.com/ProtonMail/gopenpgp/v2/crypto"
 	"github.com/google/go-querystring/query"
@@ -22,6 +23,7 @@ type Client struct {
 
 	sessionToken http.Cookie
 	csrfToken    http.Cookie
+	mfaToken     http.Cookie
 
 	// for some reason []byte is used for Passwords in gopenpgp instead of string like they do for keys...
 	userPassword   []byte
@@ -29,10 +31,21 @@ type Client struct {
 	userPublicKey  string
 	userID         string
 
+	// used for solving MFA challenges. You can block this to for example wait for user input.
+	// You shouden't run any unrelated API Calls while you are in this callback.
+	// You need to Return the Cookie that Passbolt expects to verify you MFA, usually it is called passbolt_mfa
+	MFACallback func(ctx context.Context, c *Client, res *APIResponse) (http.Cookie, error)
+
 	// Enable Debug Logging
 	Debug bool
 }
 
+// PublicKeyReponse the Body of a Public Key Api Request
+type PublicKeyReponse struct {
+	Fingerprint string `json:"fingerprint"`
+	Keydata     string `json:"keydata"`
+}
+
 // NewClient Returns a new Passbolt Client.
 // if httpClient is nil http.DefaultClient will be used.
 // if UserAgent is "" "goPassboltClient/1.0" will be used.
@@ -81,13 +94,7 @@ func NewClient(httpClient *http.Client, UserAgent, BaseURL, UserPrivateKey, User
 	return c, err
 }
 
-func (c *Client) newRequest(method, path string, body interface{}) (*http.Request, error) {
-	rel, err := url.Parse(path)
-	if err != nil {
-		return nil, fmt.Errorf("Parsing URL: %w", err)
-	}
-	u := c.baseURL.ResolveReference(rel)
-
+func (c *Client) newRequest(method, url string, body interface{}) (*http.Request, error) {
 	var buf io.ReadWriter
 	if body != nil {
 		buf = new(bytes.Buffer)
@@ -96,7 +103,8 @@ func (c *Client) newRequest(method, path string, body interface{}) (*http.Reques
 			return nil, fmt.Errorf("JSON Encoding Request: %w", err)
 		}
 	}
-	req, err := http.NewRequest(method, u.String(), buf)
+
+	req, err := http.NewRequest(method, url, buf)
 	if err != nil {
 		return nil, fmt.Errorf("Creating HTTP Request: %w", err)
 	}
@@ -108,6 +116,9 @@ func (c *Client) newRequest(method, path string, body interface{}) (*http.Reques
 	req.Header.Set("X-CSRF-Token", c.csrfToken.Value)
 	req.AddCookie(&c.sessionToken)
 	req.AddCookie(&c.csrfToken)
+	if c.mfaToken.Name != "" {
+		req.AddCookie(&c.mfaToken)
+	}
 
 	// Debugging
 	c.log("Request URL: %v", req.URL.String())
@@ -147,6 +158,7 @@ func (c *Client) do(ctx context.Context, req *http.Request, v *APIResponse) (*ht
 	if err != nil {
 		return resp, fmt.Errorf("Unable to Parse JSON API Response with HTTP Status Code %v: %w", resp.StatusCode, err)
 	}
+
 	return resp, nil
 }
 
@@ -157,19 +169,42 @@ func (c *Client) log(msg string, args ...interface{}) {
 	fmt.Printf("[go-passbolt] "+msg+"\n", args...)
 }
 
-func addOptions(s, version string, opt interface{}) (string, error) {
-	u, err := url.Parse(s)
-	if err != nil {
-		return s, fmt.Errorf("Parsing URL: %w", err)
-	}
+func generateURL(base url.URL, p, version string, opt interface{}) (string, error) {
+	base.Path = path.Join(base.Path, p)
 
 	vs, err := query.Values(opt)
 	if err != nil {
-		return s, fmt.Errorf("Getting URL Query Values: %w", err)
+		return "", fmt.Errorf("Getting URL Query Values: %w", err)
 	}
 	if version != "" {
 		vs.Add("api-version", version)
 	}
-	u.RawQuery = vs.Encode()
-	return u.String(), nil
+	base.RawQuery = vs.Encode()
+	return base.String(), nil
+}
+
+// GetUserID Gets the ID of the Current User
+func (c *Client) GetUserID() string {
+	return c.userID
+}
+
+// GetPublicKey gets the Public Key and Fingerprint of the Passbolt instance
+func (c *Client) GetPublicKey(ctx context.Context) (string, string, error) {
+	msg, err := c.DoCustomRequest(ctx, "GET", "/auth/verify.json", "v2", nil, nil)
+	if err != nil {
+		return "", "", fmt.Errorf("Doing Request: %w", err)
+	}
+
+	var body PublicKeyReponse
+	err = json.Unmarshal(msg.Body, &body)
+	if err != nil {
+		return "", "", fmt.Errorf("Parsing JSON: %w", err)
+	}
+
+	// Lets get the actual Fingerprint instead of trusting the Server
+	privateKeyObj, err := crypto.NewKeyFromArmored(c.userPrivateKey)
+	if err != nil {
+		return "", "", fmt.Errorf("Parsing Server Key: %w", err)
+	}
+	return body.Keydata, privateKeyObj.GetFingerprint(), nil
 }

api/comments.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Comment is a Comment
@@ -29,6 +30,10 @@ type GetCommentsOptions struct {
 
 // GetComments gets all Passbolt Comments an The Specified Resource
 func (c *Client) GetComments(ctx context.Context, resourceID string, opts *GetCommentsOptions) ([]Comment, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/comments/resource/"+resourceID+".json", "v2", nil, opts)
 	if err != nil {
 		return nil, err
@@ -44,6 +49,10 @@ func (c *Client) GetComments(ctx context.Context, resourceID string, opts *GetCo
 
 // CreateComment Creates a new Passbolt Comment
 func (c *Client) CreateComment(ctx context.Context, resourceID string, comment Comment) (*Comment, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "POST", "/comments/resource/"+resourceID+".json", "v2", comment, nil)
 	if err != nil {
 		return nil, err
@@ -58,6 +67,10 @@ func (c *Client) CreateComment(ctx context.Context, resourceID string, comment C
 
 // UpdateComment Updates a existing Passbolt Comment
 func (c *Client) UpdateComment(ctx context.Context, commentID string, comment Comment) (*Comment, error) {
+	err := checkUUIDFormat(commentID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/comments/"+commentID+".json", "v2", comment, nil)
 	if err != nil {
 		return nil, err
@@ -72,7 +85,11 @@ func (c *Client) UpdateComment(ctx context.Context, commentID string, comment Co
 
 // DeleteComment Deletes a Passbolt Comment
 func (c *Client) DeleteComment(ctx context.Context, commentID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/comments/"+commentID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(commentID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/comments/"+commentID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}

api/favorites.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Favorite is a Favorite
@@ -16,6 +17,10 @@ type Favorite struct {
 
 // CreateFavorite Creates a new Passbolt Favorite for the given Resource ID
 func (c *Client) CreateFavorite(ctx context.Context, resourceID string) (*Favorite, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "POST", "/favorites/resource/"+resourceID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err
@@ -31,7 +36,11 @@ func (c *Client) CreateFavorite(ctx context.Context, resourceID string) (*Favori
 
 // DeleteFavorite Deletes a Passbolt Favorite
 func (c *Client) DeleteFavorite(ctx context.Context, favoriteID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/favorites/"+favoriteID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(favoriteID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/favorites/"+favoriteID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}

api/folders.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Folder is a Folder
@@ -83,6 +84,10 @@ func (c *Client) CreateFolder(ctx context.Context, folder Folder) (*Folder, erro
 
 // GetFolder gets a Passbolt Folder
 func (c *Client) GetFolder(ctx context.Context, folderID string, opts *GetFolderOptions) (*Folder, error) {
+	err := checkUUIDFormat(folderID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/folders/"+folderID+".json", "v2", nil, opts)
 	if err != nil {
 		return nil, err
@@ -98,6 +103,10 @@ func (c *Client) GetFolder(ctx context.Context, folderID string, opts *GetFolder
 
 // UpdateFolder Updates a existing Passbolt Folder
 func (c *Client) UpdateFolder(ctx context.Context, folderID string, folder Folder) (*Folder, error) {
+	err := checkUUIDFormat(folderID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/folders/"+folderID+".json", "v2", folder, nil)
 	if err != nil {
 		return nil, err
@@ -112,7 +121,11 @@ func (c *Client) UpdateFolder(ctx context.Context, folderID string, folder Folde
 
 // DeleteFolder Deletes a Passbolt Folder
 func (c *Client) DeleteFolder(ctx context.Context, folderID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/folders/"+folderID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(folderID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/folders/"+folderID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}
@@ -121,7 +134,11 @@ func (c *Client) DeleteFolder(ctx context.Context, folderID string) error {
 
 // MoveFolder Moves a Passbolt Folder
 func (c *Client) MoveFolder(ctx context.Context, folderID, folderParentID string) error {
-	_, err := c.DoCustomRequest(ctx, "PUT", "/move/folder/"+folderID+".json", "v2", Folder{
+	err := checkUUIDFormat(folderID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "PUT", "/move/folder/"+folderID+".json", "v2", Folder{
 		FolderParentID: folderParentID,
 	}, nil)
 	if err != nil {

api/gpgkey.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // GPGKey is a GPGKey
@@ -43,6 +44,10 @@ func (c *Client) GetGPGKeys(ctx context.Context, opts *GetGPGKeysOptions) ([]GPG
 
 // GetGPGKey gets a Passbolt GPGKey
 func (c *Client) GetGPGKey(ctx context.Context, gpgkeyID string) (*GPGKey, error) {
+	err := checkUUIDFormat(gpgkeyID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/gpgkeys/"+gpgkeyID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err

api/groups.go

@@ -3,18 +3,35 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 //Group is a Group
 type Group struct {
-	ID         string            `json:"id,omitempty"`
-	Name       string            `json:"name,omitempty"`
-	Created    *Time             `json:"created,omitempty"`
-	CreatedBy  string            `json:"created_by,omitempty"`
-	Deleted    bool              `json:"deleted,omitempty"`
-	Modified   *Time             `json:"modified,omitempty"`
-	ModifiedBy string            `json:"modified_by,omitempty"`
+	ID         string `json:"id,omitempty"`
+	Name       string `json:"name,omitempty"`
+	Created    *Time  `json:"created,omitempty"`
+	CreatedBy  string `json:"created_by,omitempty"`
+	Deleted    bool   `json:"deleted,omitempty"`
+	Modified   *Time  `json:"modified,omitempty"`
+	ModifiedBy string `json:"modified_by,omitempty"`
+	// This does not Contain Profile for Users Anymore...
 	GroupUsers []GroupMembership `json:"groups_users,omitempty"`
+	// This is new and undocumented but as all the data
+	Users []GroupUser `json:"users,omitempty"`
+}
+
+type GroupUser struct {
+	User
+	JoinData GroupJoinData `json:"_join_data,omitempty"`
+}
+
+type GroupJoinData struct {
+	ID      string `json:"id,omitempty"`
+	GroupID string `json:"group_id,omitempty"`
+	UserID  string `json:"user_id,omitempty"`
+	IsAdmin bool   `json:"is_admin,omitempty"`
+	Created *Time  `json:"created,omitempty"`
 }
 
 type GroupMembership struct {
@@ -38,11 +55,14 @@ type GetGroupsOptions struct {
 	FilterHasUsers    []string `url:"filter[has_users],omitempty"`
 	FilterHasManagers []string `url:"filter[has-managers],omitempty"`
 
-	ContainModifier        bool `url:"contain[modifier],omitempty"`
-	ContainModifierProfile bool `url:"contain[modifier.profile],omitempty"`
-	ContainUser            bool `url:"contain[user],omitempty"`
-	ContainGroupUser       bool `url:"contain[group_user],omitempty"`
-	ContainMyGroupUser     bool `url:"contain[my_group_user],omitempty"`
+	ContainModifier               bool `url:"contain[modifier],omitempty"`
+	ContainModifierProfile        bool `url:"contain[modifier.profile],omitempty"`
+	ContainMyGroupUser            bool `url:"contain[my_group_user],omitempty"`
+	ContainUsers                  bool `url:"contain[users],omitempty"`
+	ContainGroupsUsers            bool `url:"contain[groups_users],omitempty"`
+	ContainGroupsUsersUser        bool `url:"contain[groups_users.user],omitempty"`
+	ContainGroupsUsersUserProfile bool `url:"contain[groups_users.user.profile],omitempty"`
+	ContainGroupsUsersUserGPGKey  bool `url:"contain[groups_users.user.gpgkey],omitempty"`
 }
 
 // UpdateGroupDryRunResult is the Result of a Update Group DryRun
@@ -105,6 +125,10 @@ func (c *Client) CreateGroup(ctx context.Context, group Group) (*Group, error) {
 
 // GetGroup gets a Passbolt Group
 func (c *Client) GetGroup(ctx context.Context, groupID string) (*Group, error) {
+	err := checkUUIDFormat(groupID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/groups/"+groupID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err
@@ -120,6 +144,10 @@ func (c *Client) GetGroup(ctx context.Context, groupID string) (*Group, error) {
 
 // UpdateGroup Updates a existing Passbolt Group
 func (c *Client) UpdateGroup(ctx context.Context, groupID string, update GroupUpdate) (*Group, error) {
+	err := checkUUIDFormat(groupID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/groups/"+groupID+".json", "v2", update, nil)
 	if err != nil {
 		return nil, err
@@ -134,6 +162,10 @@ func (c *Client) UpdateGroup(ctx context.Context, groupID string, update GroupUp
 
 // UpdateGroupDryRun Checks that a Passbolt Group update passes validation
 func (c *Client) UpdateGroupDryRun(ctx context.Context, groupID string, update GroupUpdate) (*UpdateGroupDryRunResult, error) {
+	err := checkUUIDFormat(groupID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/groups/"+groupID+"/dry-run.json", "v2", update, nil)
 	if err != nil {
 		return nil, err
@@ -148,7 +180,11 @@ func (c *Client) UpdateGroupDryRun(ctx context.Context, groupID string, update G
 
 // DeleteGroup Deletes a Passbolt Group
 func (c *Client) DeleteGroup(ctx context.Context, groupID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/groups/"+groupID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(groupID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/groups/"+groupID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}

api/mfa.go

@@ -0,0 +1,13 @@
+package api
+
+type MFAChallenge struct {
+	Provider MFAProviders `json:"providers,omitempty"`
+}
+
+type MFAProviders struct {
+	TOTP string `json:"totp,omitempty"`
+}
+
+type MFAChallengeResponse struct {
+	TOTP string `json:"totp,omitempty"`
+}

api/misc.go

@@ -1,11 +1,17 @@
 package api
 
 import (
+	"fmt"
 	"math/rand"
+	"regexp"
+	"strconv"
+	"strings"
 )
 
 const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
 
+var isUUID = regexp.MustCompile("^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")
+
 func randStringBytesRmndr(length int) string {
 	b := make([]byte, length)
 	for i := range b {
@@ -13,3 +19,35 @@ func randStringBytesRmndr(length int) string {
 	}
 	return string(b)
 }
+
+func checkAuthTokenFormat(authToken string) error {
+	splitAuthToken := strings.Split(authToken, "|")
+	if len(splitAuthToken) != 4 {
+		return fmt.Errorf("Auth Token Has Wrong amount of Fields")
+	}
+
+	if splitAuthToken[0] != splitAuthToken[3] {
+		return fmt.Errorf("Auth Token Version Fields Don't match")
+	}
+
+	if !strings.HasPrefix(splitAuthToken[0], "gpgauth") {
+		return fmt.Errorf("Auth Token Version does not start with 'gpgauth'")
+	}
+
+	length, err := strconv.Atoi(splitAuthToken[1])
+	if err != nil {
+		return fmt.Errorf("Cannot Convert Auth Token Length Field to int: %w", err)
+	}
+
+	if len(splitAuthToken[2]) != length {
+		return fmt.Errorf("Auth Token Data Length does not Match Length Field")
+	}
+	return nil
+}
+
+func checkUUIDFormat(data string) error {
+	if !isUUID.MatchString(data) {
+		return fmt.Errorf("UUID is not in the valid format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
+	}
+	return nil
+}

api/permissions.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Permission is a Permission
@@ -21,6 +22,10 @@ type Permission struct {
 
 // GetResourcePermissions gets a Resources Permissions
 func (c *Client) GetResourcePermissions(ctx context.Context, resourceID string) ([]Permission, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/permissions/resource/"+resourceID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err

api/resource_types.go

@@ -3,9 +3,10 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
-//ResourceType is the Type of a Resource
+// ResourceType is the Type of a Resource
 type ResourceType struct {
 	ID          string          `json:"id,omitempty"`
 	Slug        string          `json:"slug,omitempty"`
@@ -15,6 +16,11 @@ type ResourceType struct {
 	Modified    *Time           `json:"modified,omitempty"`
 }
 
+type ResourceTypeSchema struct {
+	Resource json.RawMessage `json:"resource"`
+	Secret   json.RawMessage `json:"secret"`
+}
+
 // GetResourceTypesOptions is a placeholder for future options
 type GetResourceTypesOptions struct {
 }
@@ -36,6 +42,10 @@ func (c *Client) GetResourceTypes(ctx context.Context, opts *GetResourceTypesOpt
 
 // GetResourceType gets a Passbolt Type
 func (c *Client) GetResourceType(ctx context.Context, typeID string) (*ResourceType, error) {
+	err := checkUUIDFormat(typeID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/resource-types/"+typeID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err

api/resources.go

@@ -3,30 +3,32 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Resource is a Resource.
 // Warning: Since Passbolt v3 some fields here may not be populated as they may be in the Secret depending on the ResourceType,
-// for now the only Field like that is the Decription.
+// for now the only Field like that is the Description.
 type Resource struct {
-	ID             string      `json:"id,omitempty"`
-	Created        *Time       `json:"created,omitempty"`
-	CreatedBy      string      `json:"created_by,omitempty"`
-	Creator        *User       `json:"creator,omitempty"`
-	Deleted        bool        `json:"deleted,omitempty"`
-	Description    string      `json:"description,omitempty"`
-	Favorite       *Favorite   `json:"favorite,omitempty"`
-	Modified       *Time       `json:"modified,omitempty"`
-	ModifiedBy     string      `json:"modified_by,omitempty"`
-	Modifier       *User       `json:"modifier,omitempty"`
-	Name           string      `json:"name,omitempty"`
-	Permission     *Permission `json:"permission,omitempty"`
-	URI            string      `json:"uri,omitempty"`
-	Username       string      `json:"username,omitempty"`
-	FolderParentID string      `json:"folder_parent_id,omitempty"`
-	ResourceTypeID string      `json:"resource_type_id,omitempty"`
-	Secrets        []Secret    `json:"secrets,omitempty"`
-	Tags           []Tag       `json:"tags,omitempty"`
+	ID             string       `json:"id,omitempty"`
+	Created        *Time        `json:"created,omitempty"`
+	CreatedBy      string       `json:"created_by,omitempty"`
+	Creator        *User        `json:"creator,omitempty"`
+	Deleted        bool         `json:"deleted,omitempty"`
+	Description    string       `json:"description,omitempty"`
+	Favorite       *Favorite    `json:"favorite,omitempty"`
+	Modified       *Time        `json:"modified,omitempty"`
+	ModifiedBy     string       `json:"modified_by,omitempty"`
+	Modifier       *User        `json:"modifier,omitempty"`
+	Name           string       `json:"name,omitempty"`
+	Permission     *Permission  `json:"permission,omitempty"`
+	URI            string       `json:"uri,omitempty"`
+	Username       string       `json:"username,omitempty"`
+	FolderParentID string       `json:"folder_parent_id,omitempty"`
+	ResourceTypeID string       `json:"resource_type_id,omitempty"`
+	ResourceType   ResourceType `json:"resource_type,omitempty"`
+	Secrets        []Secret     `json:"secrets,omitempty"`
+	Tags           []Tag        `json:"tags,omitempty"`
 }
 
 // Tag is a Passbolt Password Tag
@@ -39,7 +41,7 @@ type Tag struct {
 // GetResourcesOptions are all available query parameters
 type GetResourcesOptions struct {
 	FilterIsFavorite        bool     `url:"filter[is-favorite],omitempty"`
-	FilterIsSharedWithGroup []string `url:"filter[is-shared-with-group][],omitempty"`
+	FilterIsSharedWithGroup string   `url:"filter[is-shared-with-group],omitempty"`
 	FilterIsOwnedByMe       bool     `url:"filter[is-owned-by-me],omitempty"`
 	FilterIsSharedWithMe    bool     `url:"filter[is-shared-with-me],omitempty"`
 	FilterHasID             []string `url:"filter[has-id][],omitempty"`
@@ -89,6 +91,10 @@ func (c *Client) CreateResource(ctx context.Context, resource Resource) (*Resour
 
 // GetResource gets a Passbolt Resource
 func (c *Client) GetResource(ctx context.Context, resourceID string) (*Resource, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/resources/"+resourceID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err
@@ -104,6 +110,10 @@ func (c *Client) GetResource(ctx context.Context, resourceID string) (*Resource,
 
 // UpdateResource Updates a existing Passbolt Resource
 func (c *Client) UpdateResource(ctx context.Context, resourceID string, resource Resource) (*Resource, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/resources/"+resourceID+".json", "v2", resource, nil)
 	if err != nil {
 		return nil, err
@@ -118,7 +128,11 @@ func (c *Client) UpdateResource(ctx context.Context, resourceID string, resource
 
 // DeleteResource Deletes a Passbolt Resource
 func (c *Client) DeleteResource(ctx context.Context, resourceID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/resources/"+resourceID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/resources/"+resourceID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}
@@ -127,7 +141,11 @@ func (c *Client) DeleteResource(ctx context.Context, resourceID string) error {
 
 // MoveResource Moves a Passbolt Resource
 func (c *Client) MoveResource(ctx context.Context, resourceID, folderParentID string) error {
-	_, err := c.DoCustomRequest(ctx, "PUT", "/move/resource/"+resourceID+".json", "v2", Resource{
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "PUT", "/move/resource/"+resourceID+".json", "v2", Resource{
 		FolderParentID: folderParentID,
 	}, nil)
 	if err != nil {

api/secrets.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // Secret is a Secret
@@ -21,8 +22,31 @@ type SecretDataTypePasswordAndDescription struct {
 	Description string `json:"description,omitempty"`
 }
 
+type SecretDataTOTP struct {
+	Algorithm string `json:"algorithm"`
+	SecretKey string `json:"secret_key"`
+	Digits    int    `json:"digits"`
+	Period    int    `json:"period"`
+}
+
+// SecretDataTypeTOTP is the format a secret of resource type "totp" is stored in
+type SecretDataTypeTOTP struct {
+	TOTP SecretDataTOTP `json:"totp"`
+}
+
+// SecretDataTypePasswordDescriptionTOTP is the format a secret of resource type "password-description-totp" is stored in
+type SecretDataTypePasswordDescriptionTOTP struct {
+	Password    string         `json:"password"`
+	Description string         `json:"description,omitempty"`
+	TOTP        SecretDataTOTP `json:"totp"`
+}
+
 // GetSecret gets a Passbolt Secret
 func (c *Client) GetSecret(ctx context.Context, resourceID string) (*Secret, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/secrets/resource/"+resourceID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err

api/setup.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 type SetupInstallResponse struct {
@@ -21,6 +22,14 @@ type SetupCompleteRequest struct {
 
 // SetupInstall validates the userid and token used for Account setup, gives back the User Information
 func (c *Client) SetupInstall(ctx context.Context, userID, token string) (*SetupInstallResponse, error) {
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
+	err = checkUUIDFormat(token)
+	if err != nil {
+		return nil, fmt.Errorf("Checking Token format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/setup/install/"+userID+"/"+token+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err
@@ -36,7 +45,11 @@ func (c *Client) SetupInstall(ctx context.Context, userID, token string) (*Setup
 
 // SetupComplete Completes setup of a Passbolt Account
 func (c *Client) SetupComplete(ctx context.Context, userID string, request SetupCompleteRequest) error {
-	_, err := c.DoCustomRequest(ctx, "POST", "/setup/complete/"+userID+".json", "v2", request, nil)
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "POST", "/setup/complete/"+userID+".json", "v2", request, nil)
 	if err != nil {
 		return err
 	}

api/share.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 // ResourceShareRequest is a ResourceShareRequest
@@ -61,7 +62,11 @@ func (c *Client) SearchAROs(ctx context.Context, opts SearchAROsOptions) ([]ARO,
 
 // ShareResource Shares a Resource with AROs
 func (c *Client) ShareResource(ctx context.Context, resourceID string, shareRequest ResourceShareRequest) error {
-	_, err := c.DoCustomRequest(ctx, "PUT", "/share/resource/"+resourceID+".json", "v2", shareRequest, nil)
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "PUT", "/share/resource/"+resourceID+".json", "v2", shareRequest, nil)
 	if err != nil {
 		return err
 	}
@@ -71,8 +76,12 @@ func (c *Client) ShareResource(ctx context.Context, resourceID string, shareRequ
 
 // ShareFolder Shares a Folder with AROs
 func (c *Client) ShareFolder(ctx context.Context, folderID string, permissions []Permission) error {
+	err := checkUUIDFormat(folderID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
 	f := Folder{Permissions: permissions}
-	_, err := c.DoCustomRequest(ctx, "PUT", "/share/folder/"+folderID+".json", "v2", f, nil)
+	_, err = c.DoCustomRequest(ctx, "PUT", "/share/folder/"+folderID+".json", "v2", f, nil)
 	if err != nil {
 		return err
 	}
@@ -82,6 +91,10 @@ func (c *Client) ShareFolder(ctx context.Context, folderID string, permissions [
 
 // SimulateShareResource Simulates Shareing a Resource with AROs
 func (c *Client) SimulateShareResource(ctx context.Context, resourceID string, shareRequest ResourceShareRequest) (*ResourceShareSimulationResult, error) {
+	err := checkUUIDFormat(resourceID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "POST", "/share/simulate/resource/"+resourceID+".json", "v2", shareRequest, nil)
 	if err != nil {
 		return nil, err

api/users.go

@@ -3,6 +3,7 @@ package api
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 )
 
 const UserLocaleENUK = "en-UK"
@@ -81,6 +82,10 @@ func (c *Client) GetMe(ctx context.Context) (*User, error) {
 
 // GetUser gets a Passbolt User
 func (c *Client) GetUser(ctx context.Context, userID string) (*User, error) {
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "GET", "/users/"+userID+".json", "v2", nil, nil)
 	if err != nil {
 		return nil, err
@@ -96,6 +101,10 @@ func (c *Client) GetUser(ctx context.Context, userID string) (*User, error) {
 
 // UpdateUser Updates a existing Passbolt User
 func (c *Client) UpdateUser(ctx context.Context, userID string, user User) (*User, error) {
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return nil, fmt.Errorf("Checking ID format: %w", err)
+	}
 	msg, err := c.DoCustomRequest(ctx, "PUT", "/users/"+userID+".json", "v2", user, nil)
 	if err != nil {
 		return nil, err
@@ -110,7 +119,11 @@ func (c *Client) UpdateUser(ctx context.Context, userID string, user User) (*Use
 
 // DeleteUser Deletes a Passbolt User
 func (c *Client) DeleteUser(ctx context.Context, userID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/users/"+userID+".json", "v2", nil, nil)
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/users/"+userID+".json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}
@@ -119,7 +132,11 @@ func (c *Client) DeleteUser(ctx context.Context, userID string) error {
 
 // DeleteUserDryrun Check if a Passbolt User is Deleteable
 func (c *Client) DeleteUserDryrun(ctx context.Context, userID string) error {
-	_, err := c.DoCustomRequest(ctx, "DELETE", "/users/"+userID+"/dry-run.json", "v2", nil, nil)
+	err := checkUUIDFormat(userID)
+	if err != nil {
+		return fmt.Errorf("Checking ID format: %w", err)
+	}
+	_, err = c.DoCustomRequest(ctx, "DELETE", "/users/"+userID+"/dry-run.json", "v2", nil, nil)
 	if err != nil {
 		return err
 	}

api/verify.go

@@ -0,0 +1,67 @@
+package api
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/ProtonMail/gopenpgp/v2/crypto"
+	"github.com/google/uuid"
+)
+
+// GPGVerifyContainer is used for verification
+type GPGVerifyContainer struct {
+	Req GPGVerify `json:"gpg_auth"`
+}
+
+// GPGVerify is used for verification
+type GPGVerify struct {
+	KeyID string `json:"keyid"`
+	Token string `json:"server_verify_token,omitempty"`
+}
+
+// SetupServerVerification sets up Server Verification, Only works before login
+func (c *Client) SetupServerVerification(ctx context.Context) (string, string, error) {
+	serverKey, _, err := c.GetPublicKey(ctx)
+	if err != nil {
+		return "", "", fmt.Errorf("Getting Server Key: %w", err)
+	}
+	uuid, err := uuid.NewRandom()
+	if err != nil {
+		return "", "", fmt.Errorf("Generating UUID: %w", err)
+	}
+	token := "gpgauthv1.3.0|36|" + uuid.String() + "|gpgauthv1.3.0"
+	encToken, err := c.EncryptMessageWithPublicKey(serverKey, token)
+	if err != nil {
+		return "", "", fmt.Errorf("Encrypting Challenge: %w", err)
+	}
+	err = c.VerifyServer(ctx, token, encToken)
+	if err != nil {
+		return "", "", fmt.Errorf("Initial Verification: %w", err)
+	}
+	return token, encToken, err
+}
+
+// VerifyServer verifys that the Server is still the same one as during the Setup, Only works before login
+func (c *Client) VerifyServer(ctx context.Context, token, encToken string) error {
+	privateKeyObj, err := crypto.NewKeyFromArmored(c.userPrivateKey)
+	if err != nil {
+		return fmt.Errorf("Parsing User Private Key: %w", err)
+	}
+
+	data := GPGVerifyContainer{
+		Req: GPGVerify{
+			Token: encToken,
+			KeyID: privateKeyObj.GetFingerprint(),
+		},
+	}
+	raw, _, err := c.DoCustomRequestAndReturnRawResponse(ctx, "POST", "/auth/verify.json", "v2", data, nil)
+	if err != nil && !strings.Contains(err.Error(), "The authentication failed.") {
+		return fmt.Errorf("Sending Verification Challenge: %w", err)
+	}
+
+	if raw.Header.Get("X-GPGAuth-Verify-Response") != token {
+		return fmt.Errorf("Server Response did not Match Saved Token")
+	}
+	return nil
+}

go.mod

@@ -1,13 +1,20 @@
-module github.com/speatzle/go-passbolt
+module github.com/passbolt/go-passbolt
 
-go 1.16
+go 1.23.0
 
 require (
-	github.com/ProtonMail/go-crypto v0.0.0-20210707164159-52430bf6b52c // indirect
-	github.com/ProtonMail/gopenpgp/v2 v2.2.2
+	github.com/ProtonMail/gopenpgp/v2 v2.8.3
 	github.com/google/go-querystring v1.1.0
-	github.com/sirupsen/logrus v1.8.1 // indirect
-	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
-	golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf // indirect
-	golang.org/x/text v0.3.7 // indirect
+	github.com/google/uuid v1.6.0
+	github.com/santhosh-tekuri/jsonschema v1.2.4
+)
+
+require (
+	github.com/ProtonMail/go-crypto v1.1.6 // indirect
+	github.com/ProtonMail/go-mime v0.0.0-20230322103455-7d82a3887f2f // indirect
+	github.com/cloudflare/circl v1.6.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	golang.org/x/crypto v0.35.0 // indirect
+	golang.org/x/sys v0.30.0 // indirect
+	golang.org/x/text v0.22.0 // indirect
 )

go.sum

@@ -1,11 +1,21 @@
-github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
-github.com/ProtonMail/go-crypto v0.0.0-20210512092938-c05353c2d58c/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo=
-github.com/ProtonMail/go-crypto v0.0.0-20210707164159-52430bf6b52c h1:FP7mMdsXy0ybzar1sJeIcZtaJka0U/ZmLTW4wRpolYk=
-github.com/ProtonMail/go-crypto v0.0.0-20210707164159-52430bf6b52c/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo=
-github.com/ProtonMail/go-mime v0.0.0-20190923161245-9b5a4261663a h1:W6RrgN/sTxg1msqzFFb+G80MFmpjMw61IU+slm+wln4=
-github.com/ProtonMail/go-mime v0.0.0-20190923161245-9b5a4261663a/go.mod h1:NYt+V3/4rEeDuaev/zw1zCq8uqVEuPHzDPo3OZrlGJ4=
-github.com/ProtonMail/gopenpgp/v2 v2.2.2 h1:u2m7xt+CZWj88qK1UUNBoXeJCFJwJCZ/Ff4ymGoxEXs=
-github.com/ProtonMail/gopenpgp/v2 v2.2.2/go.mod h1:ajUlBGvxMH1UBZnaYO3d1FSVzjiC6kK9XlZYGiDCvpM=
+github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0=
+github.com/ProtonMail/go-crypto v1.0.0 h1:LRuvITjQWX+WIfr930YHG2HNfjR1uOfyf5vE0kC2U78=
+github.com/ProtonMail/go-crypto v1.0.0/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0=
+github.com/ProtonMail/go-crypto v1.1.6 h1:ZcV+Ropw6Qn0AX9brlQLAUXfqLBc7Bl+f/DmNxpLfdw=
+github.com/ProtonMail/go-crypto v1.1.6/go.mod h1:rA3QumHc/FZ8pAHreoekgiAbzpNsfQAosU5td4SnOrE=
+github.com/ProtonMail/go-mime v0.0.0-20230322103455-7d82a3887f2f h1:tCbYj7/299ekTTXpdwKYF8eBlsYsDVoggDAuAjoK66k=
+github.com/ProtonMail/go-mime v0.0.0-20230322103455-7d82a3887f2f/go.mod h1:gcr0kNtGBqin9zDW9GOHcVntrwnjrK+qdJ06mWYBybw=
+github.com/ProtonMail/gopenpgp/v2 v2.7.5 h1:STOY3vgES59gNgoOt2w0nyHBjKViB/qSg7NjbQWPJkA=
+github.com/ProtonMail/gopenpgp/v2 v2.7.5/go.mod h1:IhkNEDaxec6NyzSI0PlxapinnwPVIESk8/76da3Ct3g=
+github.com/ProtonMail/gopenpgp/v2 v2.8.3 h1:1jHlELwCR00qovx2B50DkL/FjYwt/P91RnlsqeOp2Hs=
+github.com/ProtonMail/gopenpgp/v2 v2.8.3/go.mod h1:LiuOTbnJit8w9ZzOoLscj0kmdALY7hfoCVh5Qlb0bcg=
+github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0=
+github.com/cloudflare/circl v1.3.3/go.mod h1:5XYMA4rFBvNIrhs50XuiBJ15vF2pZn4nnUKZrLbUZFA=
+github.com/cloudflare/circl v1.3.9 h1:QFrlgFYf2Qpi8bSpVPK1HBvWpx16v/1TZivyo7pGuBE=
+github.com/cloudflare/circl v1.3.9/go.mod h1:PDRU+oXvdD7KCtgKxW95M5Z8BpSCJXQORiZFnBQS5QU=
+github.com/cloudflare/circl v1.6.0 h1:cr5JKic4HI+LkINy2lg3W2jF8sHCVTBncJr5gIIq7qk=
+github.com/cloudflare/circl v1.6.0/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -13,59 +23,71 @@ github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
-github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
-github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
-github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
+github.com/santhosh-tekuri/jsonschema v1.2.4 h1:hNhW8e7t+H1vgY+1QeEQpveR6D4+OwKPXCfD2aieJis=
+github.com/santhosh-tekuri/jsonschema v1.2.4/go.mod h1:TEAUOeZSmIxTTuHatJzrvARHiuO9LYd+cIxzgEHCQI4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/crypto v0.0.0-20210322153248-0c34fe9e7dc2/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
-golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 h1:HWj/xjIHfjYU5nVXpTM0s39J9CbLn7Cc5a7IC5rwsMQ=
-golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
-golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4=
-golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
-golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
-golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE=
-golang.org/x/mobile v0.0.0-20200801112145-973feb4309de/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4=
-golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY=
-golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
-golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
-golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4=
+golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
+golang.org/x/crypto v0.26.0 h1:RrRspgV4mU+YwB4FYnuBoKsUapNIL5cohGAmSH3azsw=
+golang.org/x/crypto v0.26.0/go.mod h1:GY7jblb9wI+FOo5y8/S2oY4zWP07AkOJ4+jxCqdqn54=
+golang.org/x/crypto v0.35.0 h1:b15kiHdrGCHrP6LvwaQ3c03kgNhhiMgvlhxHQhmg2Xs=
+golang.org/x/crypto v0.35.0/go.mod h1:dy7dXNW32cAb/6/PRuTNsix8T+vJAqvuIy5Bli/x0YQ=
+golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
+golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
+golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
+golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
+golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
+golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf h1:2ucpDCmfkl8Bd/FsLtiD653Wf96cW37s+iGx93zsu4k=
-golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg=
+golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
+golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
+golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
+golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
+golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
+golang.org/x/text v0.17.0 h1:XtiM5bkSOt+ewxlOE/aE/AKEHibwj/6gvWMl9Rsh0Qc=
+golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM=
+golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
-golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
+golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
+golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

helper/folder.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 // CreateFolder Creates a new Folder

helper/group.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 // GroupMembershipOperation creates/modifies/deletes a group membership
@@ -14,7 +14,7 @@ type GroupMembershipOperation struct {
 	Delete         bool
 }
 
-// GroupMembership containes who and what kind of membership they have with a group
+// GroupMembership contains who and what kind of membership they have with a group
 type GroupMembership struct {
 	UserID         string
 	Username       string
@@ -49,7 +49,9 @@ func CreateGroup(ctx context.Context, c *api.Client, name string, operations []G
 func GetGroup(ctx context.Context, c *api.Client, groupID string) (string, []GroupMembership, error) {
 	// for some reason the groups index api call does not give back the groups_users even though it is supposed to, so i have to do this...
 	groups, err := c.GetGroups(ctx, &api.GetGroupsOptions{
-		ContainGroupUser: true,
+		ContainGroupsUsers:            true,
+		ContainGroupsUsersUser:        true,
+		ContainGroupsUsersUserProfile: true,
 	})
 	if err != nil {
 		return "", nil, fmt.Errorf("Getting Groups: %w", err)
@@ -77,7 +79,7 @@ func GetGroup(ctx context.Context, c *api.Client, groupID string) (string, []Gro
 func UpdateGroup(ctx context.Context, c *api.Client, groupID, name string, operations []GroupMembershipOperation) error {
 	// for some reason the groups index api call does not give back the groups_users even though it is supposed to, so i have to do this...
 	groups, err := c.GetGroups(ctx, &api.GetGroupsOptions{
-		ContainGroupUser: true,
+		ContainGroupsUsers: true,
 	})
 	if err != nil {
 		return fmt.Errorf("Getting Groups: %w", err)

helper/mfa.go

@@ -0,0 +1,54 @@
+package helper
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/passbolt/go-passbolt/api"
+)
+
+// AddMFACallbackTOTP adds a MFA callback to the client that generates OTP Codes on demand using a Token with configurable retries and delay
+func AddMFACallbackTOTP(c *api.Client, retrys uint, retryDelay, offset time.Duration, token string) {
+	c.MFACallback = func(ctx context.Context, c *api.Client, res *api.APIResponse) (http.Cookie, error) {
+		challenge := api.MFAChallenge{}
+		err := json.Unmarshal(res.Body, &challenge)
+		if err != nil {
+			return http.Cookie{}, fmt.Errorf("Parsing MFA Challenge")
+		}
+		if challenge.Provider.TOTP == "" {
+			return http.Cookie{}, fmt.Errorf("Server Provided no TOTP Provider")
+		}
+		for i := uint(0); i < retrys+1; i++ {
+			var code string
+			code, err = GenerateOTPCode(token, time.Now().Add(offset))
+			if err != nil {
+				return http.Cookie{}, fmt.Errorf("Error Generating MFA Code: %w", err)
+			}
+			req := api.MFAChallengeResponse{
+				TOTP: code,
+			}
+			var raw *http.Response
+			raw, _, err = c.DoCustomRequestAndReturnRawResponse(ctx, "POST", "mfa/verify/totp.json", "v2", req, nil)
+			if err != nil {
+				if errors.Unwrap(err) != api.ErrAPIResponseErrorStatusCode {
+					return http.Cookie{}, fmt.Errorf("Doing MFA Challenge Response: %w", err)
+				}
+				// MFA failed, so lets wait just let the loop try again
+				time.Sleep(retryDelay)
+			} else {
+				// MFA worked so lets find the cookie and return it
+				for _, cookie := range raw.Cookies() {
+					if cookie.Name == "passbolt_mfa" {
+						return *cookie, nil
+					}
+				}
+				return http.Cookie{}, fmt.Errorf("Unable to find Passbolt MFA Cookie")
+			}
+		}
+		return http.Cookie{}, fmt.Errorf("Failed MFA Challenge 3 times: %w", err)
+	}
+}

helper/resources.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 // CreateResource Creates a Resource where the Password and Description are Encrypted and Returns the Resources ID
@@ -18,6 +18,7 @@ func CreateResource(ctx context.Context, c *api.Client, folderParentID, name, us
 	for _, tmp := range types {
 		if tmp.Slug == "password-and-description" {
 			rType = &tmp
+			break
 		}
 	}
 	if rType == nil {
@@ -41,6 +42,11 @@ func CreateResource(ctx context.Context, c *api.Client, folderParentID, name, us
 		return "", fmt.Errorf("Marshalling Secret Data: %w", err)
 	}
 
+	err = validateSecretData(rType, string(secretData))
+	if err != nil {
+		return "", fmt.Errorf("Validating Secret Data: %w", err)
+	}
+
 	encSecretData, err := c.EncryptMessage(string(secretData))
 	if err != nil {
 		return "", fmt.Errorf("Encrypting Secret Data for User me: %w", err)
@@ -122,6 +128,21 @@ func GetResourceFromData(c *api.Client, resource api.Resource, secret api.Secret
 		}
 		pw = secretData.Password
 		desc = secretData.Description
+	case "password-description-totp":
+		rawSecretData, err := c.DecryptMessage(secret.Data)
+		if err != nil {
+			return "", "", "", "", "", "", fmt.Errorf("Decrypting Secret Data: %w", err)
+		}
+
+		var secretData api.SecretDataTypePasswordDescriptionTOTP
+		err = json.Unmarshal([]byte(rawSecretData), &secretData)
+		if err != nil {
+			return "", "", "", "", "", "", fmt.Errorf("Parsing Decrypted Secret Data: %w", err)
+		}
+		pw = secretData.Password
+		desc = secretData.Description
+	case "totp":
+		// nothing fits into the interface in this case
 	default:
 		return "", "", "", "", "", "", fmt.Errorf("Unknown ResourceType: %v", rType.Slug)
 	}
@@ -218,10 +239,62 @@ func UpdateResource(ctx context.Context, c *api.Client, resourceID, name, userna
 			return fmt.Errorf("Marshalling Secret Data: %w", err)
 		}
 		secretData = string(res)
+	case "password-description-totp":
+		secret, err := c.GetSecret(ctx, resourceID)
+		if err != nil {
+			return fmt.Errorf("Getting Secret: %w", err)
+		}
+		oldSecretData, err := c.DecryptMessage(secret.Data)
+		if err != nil {
+			return fmt.Errorf("Decrypting Secret: %w", err)
+		}
+		var oldSecret api.SecretDataTypePasswordDescriptionTOTP
+		err = json.Unmarshal([]byte(oldSecretData), &secretData)
+		if err != nil {
+			return fmt.Errorf("Parsing Decrypted Secret Data: %w", err)
+		}
+		if password != "" {
+			oldSecret.Password = password
+		}
+		if description != "" {
+			oldSecret.Description = description
+		}
+
+		res, err := json.Marshal(&oldSecret)
+		if err != nil {
+			return fmt.Errorf("Marshalling Secret Data: %w", err)
+		}
+		secretData = string(res)
+	case "totp":
+		secret, err := c.GetSecret(ctx, resourceID)
+		if err != nil {
+			return fmt.Errorf("Getting Secret: %w", err)
+		}
+		oldSecretData, err := c.DecryptMessage(secret.Data)
+		if err != nil {
+			return fmt.Errorf("Decrypting Secret: %w", err)
+		}
+		var oldSecret api.SecretDataTypeTOTP
+		err = json.Unmarshal([]byte(oldSecretData), &secretData)
+		if err != nil {
+			return fmt.Errorf("Parsing Decrypted Secret Data: %w", err)
+		}
+		// since we don't have totp parameters we don't do anything
+
+		res, err := json.Marshal(&oldSecret)
+		if err != nil {
+			return fmt.Errorf("Marshalling Secret Data: %w", err)
+		}
+		secretData = string(res)
 	default:
 		return fmt.Errorf("Unknown ResourceType: %v", rType.Slug)
 	}
 
+	err = validateSecretData(rType, secretData)
+	if err != nil {
+		return fmt.Errorf("Validating Secret Data: %w", err)
+	}
+
 	newResource.Secrets = []api.Secret{}
 	for _, user := range users {
 		var encSecretData string

helper/setup.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 
 	"github.com/ProtonMail/gopenpgp/v2/crypto"
 	"github.com/ProtonMail/gopenpgp/v2/helper"
@@ -31,7 +31,7 @@ func SetupAccount(ctx context.Context, c *api.Client, userID, token, password st
 
 	keyName := install.Profile.FirstName + " " + install.Profile.LastName + " " + install.Username
 
-	privateKey, err := helper.GenerateKey(keyName, install.Username, []byte(password), "rsa", 2048)
+	privateKey, err := helper.GenerateKey(keyName, install.Username, []byte(password), "rsa", 4096)
 	if err != nil {
 		return "", fmt.Errorf("Generating Private Key: %w", err)
 	}

helper/setup_test.go

@@ -8,7 +8,7 @@ import (
 	"os"
 	"testing"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 var client *api.Client
@@ -31,6 +31,9 @@ func TestMain(m *testing.M) {
 		panic(fmt.Errorf("Creating Registration Client: %w", err))
 	}
 
+	// Debug Output
+	rc.Debug = true
+
 	ctx := context.TODO()
 
 	privkey, err := SetupAccount(ctx, rc, userID, token, "password123")
@@ -43,6 +46,9 @@ func TestMain(m *testing.M) {
 		panic(fmt.Errorf("Setup Client: %w", err))
 	}
 
+	// Debug Output
+	c.Debug = true
+
 	c.Login(ctx)
 	if err != nil {
 		panic(fmt.Errorf("Login Client: %w", err))

helper/share.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 // ShareOperation defines how Resources are to be Shared With Users/Groups
@@ -63,6 +63,22 @@ func ShareResource(ctx context.Context, c *api.Client, resourceID string, change
 		return fmt.Errorf("Decrypting Resource Secret: %w", err)
 	}
 
+	// Secret Validation
+	resource, err := c.GetResource(ctx, resourceID)
+	if err != nil {
+		return fmt.Errorf("Getting Resource: %w", err)
+	}
+
+	rType, err := c.GetResourceType(ctx, resource.ResourceTypeID)
+	if err != nil {
+		return fmt.Errorf("Getting ResourceType: %w", err)
+	}
+
+	err = validateSecretData(rType, secretData)
+	if err != nil {
+		return fmt.Errorf("Validating Secret Data: %w", err)
+	}
+
 	simulationResult, err := c.SimulateShareResource(ctx, resourceID, shareRequest)
 	if err != nil {
 		return fmt.Errorf("Simulate Share Resource: %w", err)

helper/totp.go

@@ -0,0 +1,63 @@
+package helper
+
+import (
+	"crypto/hmac"
+	"crypto/sha1"
+	"encoding/base32"
+	"encoding/binary"
+	"fmt"
+	"math"
+	"strings"
+	"time"
+)
+
+const (
+	mask1              = 0xf
+	mask2              = 0x7f
+	mask3              = 0xff
+	timeSplitInSeconds = 30
+	shift24            = 24
+	shift16            = 16
+	shift8             = 8
+	codeLength         = 6
+)
+
+// GenerateOTPCode generates a 6 digit TOTP from the secret Token.
+func GenerateOTPCode(token string, when time.Time) (string, error) {
+	timer := uint64(math.Floor(float64(when.Unix()) / float64(timeSplitInSeconds)))
+	// Remove spaces, some providers are giving us in a readable format
+	// so they add spaces in there. If it's not removed while pasting in,
+	// remove it now.
+	token = strings.Replace(token, " ", "", -1)
+
+	// It should be uppercase always
+	token = strings.ToUpper(token)
+
+	// Remove all the extra "=" padding at the end
+	token = strings.TrimRight(token, "=")
+
+	secretBytes, err := base32.StdEncoding.WithPadding(base32.NoPadding).DecodeString(token)
+	if err != nil {
+		return "", fmt.Errorf("Decoding token string: %w", err)
+	}
+
+	buf := make([]byte, 8)
+	mac := hmac.New(sha1.New, secretBytes)
+
+	binary.BigEndian.PutUint64(buf, timer)
+	_, _ = mac.Write(buf)
+	sum := mac.Sum(nil)
+
+	// http://tools.ietf.org/html/rfc4226#section-5.4
+	offset := sum[len(sum)-1] & mask1
+	value := int64(((int(sum[offset]) & mask2) << shift24) |
+		((int(sum[offset+1] & mask3)) << shift16) |
+		((int(sum[offset+2] & mask3)) << shift8) |
+		(int(sum[offset+3]) & mask3))
+
+	modulo := int32(value % int64(math.Pow10(codeLength)))
+
+	format := fmt.Sprintf("%%0%dd", codeLength)
+
+	return fmt.Sprintf(format, modulo), nil
+}

helper/totp_test.go

@@ -0,0 +1,36 @@
+package helper
+
+import (
+	"testing"
+	"time"
+)
+
+var testCases = []struct {
+	description string
+	token       string
+	expectErr   bool
+}{
+	{"generates otpcode from token with padding", "PGWXXL7B66MMSRBAWSKEKIYD3P675KRJ===", false},
+	{"generates otpcode from token without padding", "JBSWY3DPEHPK3PXPJBSWY3DPEHPK3PXP", false},
+	{"invalid token format", "INVALIDTOKEN123", true},
+}
+
+func TestGenerateOTPCode(t *testing.T) {
+	for _, tc := range testCases {
+		t.Run(tc.description, func(t *testing.T) {
+			code, err := GenerateOTPCode(tc.token, time.Now())
+
+			if tc.expectErr {
+				if err == nil {
+					t.Errorf("Expected error for input '%s', but got none", tc.token)
+				}
+			} else {
+				if err != nil {
+					t.Errorf("GenerateOTPCode returned an error: %s", err.Error())
+				} else if len(code) != 6 {
+					t.Errorf("Expected 6-digit OTP, got: %s", code)
+				}
+			}
+		})
+	}
+}

helper/user.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
 )
 
 // CreateUser Creates a new User

helper/util.go

@@ -1,9 +1,13 @@
 package helper
 
 import (
+	"bytes"
+	"encoding/json"
 	"fmt"
+	"strings"
 
-	"github.com/speatzle/go-passbolt/api"
+	"github.com/passbolt/go-passbolt/api"
+	"github.com/santhosh-tekuri/jsonschema"
 )
 
 func getPublicKeyByUserID(userID string, Users []api.User) (string, error) {
@@ -32,3 +36,44 @@ func getSecretByResourceID(secrets []api.Secret, resourceID string) (*api.Secret
 	}
 	return nil, fmt.Errorf("Cannot Find Secret for id %v", resourceID)
 }
+
+func validateSecretData(rType *api.ResourceType, secretData string) error {
+	var schemaDefinition api.ResourceTypeSchema
+	err := json.Unmarshal([]byte(rType.Definition), &schemaDefinition)
+	if err != nil {
+		// Workaround for inconsistant API Responses where sometime the Schema is embedded directly and sometimes it's escaped as a string
+		if err.Error() == "json: cannot unmarshal string into Go value of type api.ResourceTypeSchema" {
+			var tmp string
+			err = json.Unmarshal([]byte(rType.Definition), &tmp)
+			if err != nil {
+				return fmt.Errorf("Workaround Unmarshal Json Schema String: %w", err)
+			}
+
+			err = json.Unmarshal([]byte(tmp), &schemaDefinition)
+			if err != nil {
+				return fmt.Errorf("Workaround Unmarshal Json Schema: %w", err)
+			}
+
+		} else {
+			return fmt.Errorf("Unmarshal Json Schema: %w", err)
+		}
+	}
+
+	comp := jsonschema.NewCompiler()
+
+	err = comp.AddResource("secret.json", bytes.NewReader(schemaDefinition.Secret))
+	if err != nil {
+		return fmt.Errorf("Adding Json Schema: %w", err)
+	}
+
+	schema, err := comp.Compile("secret.json")
+	if err != nil {
+		return fmt.Errorf("Compiling Json Schema: %w", err)
+	}
+
+	err = schema.Validate(strings.NewReader(secretData))
+	if err != nil {
+		return fmt.Errorf("Validating Secret Data: %w", err)
+	}
+	return nil
+}