guitarrapc / base64urlcore

CLI tool for base64 & base64url encode/decode for URL applications.

Base64UrlCore

Converting to, and from, base64url

base64urls offer you to run Base64UrlCore on the CLI.

Install

CLI

dotnet tool install -g base64urls

Library

dotnet add package Base64UrlCore

CLI Usage

SYNTAX

base64urls [-version] [-help] [encode|decode|escape|unescape] [args]

Decode

base64url encode input. Input should be a string or a Buffer.

$ base64urls decode QyMgaXMgYXdlc29tZQ==
C# is awesome

Encode

Convert a base64url encoded string into a raw string. The encoding argument can be used if the input is a string that's not utf8.

$ base64urls encode "C# is awesome."
QyMgaXMgYXdlc29tZS4=

Escape

Convert a base64 encoded string to a base64url encoded string.

$ base64urls escape "This+is/goingto+escape=="
This-is_goingto-escape

Unescape

Convert a base64url encoded string to a base64 encoded string.

$ base64urls unescape "This-is_goingto-escape"
This+is/goingto+escape==

Library Usage

Decode

base64url encode input. Input should be a string or a Buffer.

Base64Url.Decode("QyMgaXMgYXdlc29tZQ==");
// C# is awesome

Encode

Convert a base64url encoded string into a raw string. The encoding argument can be used if the input is a string that's not utf8.

Base64Url.Encode("C# is awesome.");
// QyMgaXMgYXdlc29tZS4=

Escape

Convert a base64 encoded string to a base64url encoded string.

Base64Url.Escape("This+is/goingto+escape==");
// "This-is_goingto-escape" 

Unescape

Convert a base64url encoded string to a base64 encoded string.

Base64Url.Unescape("This-is_goingto-escape");
// "This+is/goingto+escape=="

PadString

Add padding to encoded string.

Base64Url.PadString("aG9nZW1vZ2U");
// aG9nZW1vZ2U=

RemovePadding

Remove padding from encoded string.

Base64Url.RemovePadding("MQ==");
// MQ

Docker

Library

docker build -t base64urlcore . -f Dockerfile.Base64UrlCore

global tool

docker build -t base64urls . -f Dockerfile.base64urls

CI

Retired appveyor, now using CircleCI.

Local run

validate ci config.

docker run --rm -v $(pwd):/data circleci/circleci-cli:alpine config validate /data/.circleci/config.yml

Code Coverage

Using Coverlet and dotnet-reportgenerator. Add coverlet.msbuild to your csproj, add dotnet global tool dotnet tool install -g dotnet-reportgenerator-globaltool, and add environment variables CODECOV_TOKEN to CI. (You can find TOKEN at https://codecov.io/gh/guitarrapc/Base64UrlCore)

NuGet push

Add environment variable NUGET_KEY to CI. You can generate it at https://www.nuget.org/account/apikeys.

License

MIT

base64urlcore's Issues

--version doesnt work properly.

PS C:\Users\user1\Desktop\core 3> mkdir base63tooltest


    Directory: C:\Users\user1\Desktop\core 3


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----        9/27/2019  12:47 PM                base63tooltest


PS C:\Users\user1\Desktop\core 3> cd .\base63tooltest\
PS C:\Users\user1\Desktop\core 3\base63tooltest> dotnet new tool-manifest; dotnet tool install base64urls --ve
rsion 1.1.0;  dotnet tool install base64urls --global;
The template "Dotnet local tool manifest file" was created successfully.
You can invoke the tool from this directory using the following commands: 'dotnet tool run base64urls' or 'dotnet base64urls'.
Tool 'base64urls' (version '1.1.0') was successfully installed. Entry is added to the manifest file C:\Users\user1\Desktop\core 3\base63tooltest\.config\dotnet-tools.json.
You can invoke the tool using the following command: base64urls
Tool 'base64urls' (version '1.1.1') was successfully installed.
PS C:\Users\user1\Desktop\core 3\base63tooltest> base64urls
Usage: base64urls [-version] [-help] [decode|encode|escape|unescape] [args]
E.g., run this: base64urls decode QyMgaXMgYXdlc29tZQ==
E.g., run this: base64urls encode "C# is awesome."
E.g., run this: base64urls escape "This+is/goingto+escape=="
E.g., run this: base64urls unescape "This-is_goingto-escape"
PS C:\Users\user1\Desktop\core 3\base63tooltest> base64urls --version
base64urls v1.0.0.0
PS C:\Users\user1\Desktop\core 3\base63tooltest>

v1.0.0.0 is not the version reported by the dotnet tool install or nuget.