Coder Social home page Coder Social logo

pgpsharp's Introduction

About PgpSharp

This project is an attempt at providing very basic PGP functionality through a C# interface, including listing keys, encrypting/signing data, and decrypting data. It does not generate or manage keys at the moment.

Get it on NuGet

See the package page, or run

Install-Package PgpSharp

Using the lib

The main interface to use is IPgpTool. The lib provides a default impelementation that merely wraps around the GnuPG binary for windows and can be instantiated like this:

IPgpTool tool = new GnuPGTool();

By default the GnuPGTool will try to find the GnuPG binary in the standard install folder. To override the binary file path set this property:

GnuPGConfig.GnuPGExePath = @"your\path\to\gpg2.exe";

To encrypt/sign/decrypt data, you would use the ProcessData() method of the interface, and you have the option of using the StreamDataInput (for processing streams) or FileDataInput (for processing files).

// example encrypting a file
var encryptArg = new FileDataInput
{
    Armor = true,
    InputFile = @"path\to\src\file",
    OutputFile = @"path\to\output\file",
    Operation = DataOperation.Encrypt,
    Recipient = "recipient's key id",
};
tool.ProcessData(encryptArg);

// example decrypting a file
SecureString yourPassphrase = ... // somehow generate it
var decryptArg = new FileDataInput
{
    InputFile = @"path\to\encrypted\file",
    OutputFile = @"path\to\output\file",
    Operation = DataOperation.Decrypt,
    Passphrase = yourPassphrase
};
tool.ProcessData(decryptArg);

Details on which properties to use for different sign/encrypt/decrypt operation is available in the intellisense of that property. The sample WPF project also allows you to play with the different operations.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.