Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sebmillet/pkfile


https://github.com/sebmillet/pkfile

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
   pkfile, a portable utility to work on pkcs files

   ================================================



Date: 2016-01-17 11:51 +0100



Contents:



      I. WHAT IS PKFILE?

     II. WHY PKFILE?

    III. LICENCE

     IV. COMPILATION AND INSTALLATION

      V. CREDITS



I.    WHAT IS PKFILE?



It is a program to work on PKCS files.

It can read PEM-encoded and DER-encoded files and by default it will work out

which encoding is being used, unless you force it with -f option.



It provides the following features.



Launched without option:

- Display DER-encoded data in a hierarchical, tree-like, presentation.



Launched with -x option

- Take input and output it in a DER-encoded way.

  If the input is already DER-encoded, no transformation is done and the

  output is just identical to the input.

  If the input is PEM-encoded, pkfile will perform a decoding of PEM content,

  and decrypt data if applicable.



See URL

    https://en.wikipedia.org/wiki/X.690#DER_encoding

for details about DER encoding.



*IMPORTANT*

  pkfile will decrypt PEM data if need be, and by default will output the

  content in a DER-encoded way => not encrypted.

  Therefore pkfile is not suitable to deal with private keys in a production

  environment.



  * IT IS MEANT FOR TRAINING PURPOSES ONLY *



II.   WHY PKFILE?



It is meant to be didactic.

It eases dealing with PKCS files at a low level, like, manually checking a

certificate by doing the RSA or EC calculations directly with key data.



pkfile will help calculate the hash of TBSCertificate and extract integers

from key data.



Using -N option, it can also enter a data block (of type BIT STRING or OCTET

STRING) to parse it as if being a standalone DER-encoded file.



III.  LICENCE



See COPYING file that comes along with the package the program belongs to.



IV.   COMPILATION AND INSTALLATION



By default the generation is done with linking against openssl library.

This allows pkfile to:

- Manage PEM files (decode and decrypt)

- Display the object names after their OID

Under Linux the link is dynamic, under Windows it is static.



* LINUX



To compile under Linux, execute in the extracted archive root:

    ./configure

    make

    make install (or 'sudo make install')



  Note about SSL

  The SSL feature requires SSL development library to be available on the

  system you compile on. The package name is libssl-dev for DEB packages and

  openssl-devel (not tested) in RPM ones. For example under Ubuntu, execute:

    sudo apt-get install libssl-dev



* WINDOWS



1) Generation with Microsoft Visual C++



This generation was checked with msvc version 2015, 32-bit compilation.



1.1) Compilation of the openssl library with msvc



See

    http://developer.covenanteyes.com/building-openssl-for-visual-studio/



As compilation is done from MSVC command-line shell, you need a PERL

interpreter installed on Windows to proceed.

ActiveState or Strawberry are fine while ActiveState is said by the URL above

to be more stable.



From msvc command-line and after CDing to the extracted openssl archive, run

(for 32-bit)



perl Configure VC-WIN32 --prefix=C:\openssl-msvc

    or (for 64-bit)

perl Configure VC-WIN64 --prefix=C:\openssl-msvc



Then

ms\do_ms (for 32-bit) or ms\do_win64a (for 64-bit)



Then

nmake -f ms\nt.mak

nmake -f ms\nt.mak install



1.2) pkfile.exe generation



To compile under Windows with Microsoft Visual C++ 2015, launch MSVC

command-line and, in the extracted archive root, execute:

    nmake -f makefile.vc



You may need to update makefile.vc depending on where you built openssl lib

in.



2) Generation with Mingw



This generation was checked using Mingw 32-bit.



2.1) Compiling the openssl library with mingw



To build a static version of openssl with mingw, see the following URLs:

    http://stackoverflow.com/questions/9379363/how-to-build-openssl-with-mingw-in-windows

    http://www.wagner.pp.ru/~vitus/articles/openssl-mingw.html

    http://lists.pjsip.org/pipermail/pjsip_lists.pjsip.org/2008-February/001644.html



  Instructions:



  1. Download the source from there and extract it:

     http://www.openssl.org/source/openssl-1.0.2e.tar.gz

     (select the last version ; as of January 5th, 2016, it is 1.0.2e)

  2. Open a MSYS window (from MinGW\msys\1.0\msys.bat)

  3. Run the command (32 bits)

     perl Configure mingw no-shared no-asm --prefix=/c/openssl

     Or (64 bits)

     perl Configure mingw64 no-shared no-asm --prefix=/c/openssl-x64

  4. Run

     make

     make install

  5. Under the directory you built openssl in, you will find the libraries, example:

     C:\openssl\lib\libcrypto.a



2.2) pkfile.exe generation



To compile under Windows with mingw, in the extracted archive root, execute:

    mingw32-make -f makefile.mingw



You may need to update makefile.mingw depending on where you built openssl lib

in.



V.    CREDITS



The code to detect charset and print the tree elements has been taken from

tree source, version 1.7.0.

The "TREE COMMAND FOR LINUX HOMEPAGE" is here:

    http://mama.indstate.edu/users/ice/tree