Skip to content

docs(dotnet): document https-only URL validation and AllowInsecureUrls #79

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.

Sign up for GitHub

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

Merged
rubenhensen merged 1 commit into from
May 13, 2026
Merged

docs(dotnet): document https-only URL validation and AllowInsecureUrls #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/repos/postguard-dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ var pg = new PostGuard(new PostGuardConfig
PkgUrl = "https://pkg.staging.postguard.eu",
CryptifyUrl = "https://fileshare.staging.postguard.eu"
});
// PkgUrl and CryptifyUrl must be absolute https:// URLs.
// The constructor throws ArgumentException otherwise.
// Set AllowInsecureUrls = true to permit http://localhost for local dev.

var sealed = pg.Encrypt(new EncryptInput
{
Expand Down
7 changes: 5 additions & 2 deletions docs/sdk/dotnet-encryption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,13 @@ var pg = new PostGuard(new PostGuardConfig
});
```

`PkgUrl` and `CryptifyUrl` must be absolute `https://` URLs. The constructor throws `ArgumentException` for any other scheme (including `http://`, `ftp://`, `ws://`), as well as for relative or empty values. Set `AllowInsecureUrls = true` to permit `http://localhost` during local development.

| Option | Type | Required | Description |
|---|---|---|---|
| `PkgUrl` | `string` | Yes | URL of the PKG server |
| `CryptifyUrl` | `string` | No | URL of the Cryptify file storage service. Required for `UploadAsync()`. |
| `PkgUrl` | `string` | Yes | URL of the PKG server. Must be an absolute `https://` URL. |
| `CryptifyUrl` | `string` | No | URL of the Cryptify file storage service. Required for `UploadAsync()`. Must be an absolute `https://` URL. |
| `AllowInsecureUrls` | `bool` | No | Allow `http://localhost` URLs for local dev. Default `false`. Any non-`https://` value still throws `ArgumentException`. |
| `Headers` | `Dictionary<string, string>` | No | Custom HTTP headers included in all requests |

## Encrypt
Expand Down
Loading