From 207c353f8fdceb2a8224ae7473c5889b1a75f5dd Mon Sep 17 00:00:00 2001 From: Josh Bradley Date: Wed, 10 May 2017 01:47:30 -0400 Subject: [PATCH] version 1 release --- DESCRIPTION | 2 +- README.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 56ac316..7403dc7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: rpki Title: A PKI-Enabled Wrapper Around the 'Httr' Package -Version: 0.1.0 +Version: 1.0.0 Authors@R: c( person("Joshua", "Bradley", , "jgbradley1@gmail.com", role = c("aut", "cre")), person("nbgallery", role = "cph") diff --git a/README.md b/README.md index 553d301..d18156f 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,22 @@ rpki is a wrapper package that PKI-enables the httr package. Conceptually, rpki is similar to the Ruby [MyPKI](https://github.com/nbgallery/mypki) package and Python [pypki2](https://github.com/nbgallery/pypki2) package, and is intended to use the same mypki configuration file. ## Details -rpki can run in both interactive and non-interactive R sessions. The default behavior of rpki is to override the config() settings of httr using the PKI settings found in a .mypki configuration file. It will attempt to search for and use a pre-existing .mypki configuration file located in the home directory (~/.mypki). If the configuration file is not found or is invalid, the user will be prompted for file paths to a certificate authority bundle and a PKI file. rpki sets the following httr config settings +rpki can run in both interactive and non-interactive R sessions. The default behavior of rpki is to override the config() settings of httr using the PKI settings found in a .mypki configuration file. It will attempt to search for and use a pre-existing .mypki configuration file located in the home directory (~/.mypki). If the configuration file is not found or is invalid (wrong format, nonexistent file paths, .etc), the user will be prompted for file paths to a certificate authority bundle and a PKI file. rpki sets the following httr config settings * cainfo * sslcert * sslkey +### mypki Configuration File +rpki expects a mypki configuration file to be json formatted and at minimum specify the absolute file paths to a Certificate Authority (CA) bundle and a PKCS12 digital certificate. +```json +{ + "ca": "/path/to/certificate_authority_bundle.crt", + "p12": { + "path": "/path/to/pki_digital_certificate.p12" + } +} +``` + ## Examples ### Fetching a URL ```r