mdwheele/incommon-cli

Command-line Utility for InCommon Certificate Manager SSL Web Service API

InCommon CM SSL Web Service Client Command-line Utility

Command-line Utility for InCommon Certificate Manager SSL Web Service API, _(*1)

, _(*2)

Notice: This an alpha-quality software at the moment. Do NOT use in production anything!!, _(*3)

This utility provides an access layer to limited functionality of the InCommon Certificate Manager SSL SOAP Web Service., _(*4)

Goals

• Provide a command-line interface for performing bulk CSR enrollments and Certificate retrieval.

This package is compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request., _(*5)

Install

Via Composer, _(*6)

``` json { "require": { "mdwheele/incommon-cli": "dev-master" } }, <sub>(*7)</sub>

## Requirements

The following versions of PHP are supported by this version.

* PHP 5.3
* PHP 5.4
* PHP 5.5

## Usage

This is a Symfony Console application. To get everything set up, you will need to clone down the project and
run `composer install`.

To run the thing, you'll need to run `bin/incommon`. This is the entry point for all the registered commands.

### Enroll Certs (Sending off the CSRs)

Enrolling certs requires a directory full of CSRs. You will provide this as a CLI argument.

```bash
[vagrant@kraken incommon-cli]$ bin/incommon help cert:enroll
Usage:
 cert:enroll [csr_paths1] ... [csr_pathsN]

Arguments:
 csr_paths             Paths to CSR files.

After running, it's going to go through some interactive prompts; asking for your InCommon login credentials as well as the organization identifer and secret key., <sub>(*8)</sub>

After setting all that up, it'll just go to town., <sub>(*9)</sub>

Check status of enrolled certs

[vagrant@kraken incommon-cli]$ bin/incommon help cert:status
Usage:
 cert:status sslid

Arguments:
 sslid                 Path to CSR or glob.

`bin/incommon cert:status 123456, <sub>(*10)</sub>

Download certs

Documentation

I will have much more documentation coming soon. Until then, this is basically it., <sub>(*11)</sub>

Contributing

Contributions are welcome and will be fully credited., <sub>(*12)</sub>

We accept contributions via Pull Requests on Github., <sub>(*13)</sub>

Pull Requests

• PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer., <sub>(*14)</sub>

• Add tests! - Your patch won't be accepted if it doesn't have tests., <sub>(*15)</sub>

• Document any change in behaviour - Make sure the README and any other relevant documentation are kept up-to-date., <sub>(*16)</sub>

• Consider our release cycle - We try to follow semver. Randomly breaking public APIs is not an option., <sub>(*17)</sub>

• Create topic branches - Don't ask us to pull from your master branch., <sub>(*18)</sub>

• One pull request per feature - If you want to do more than one thing, send multiple pull requests., <sub>(*19)</sub>

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting., <sub>(*20)</sub>

Running Tests

bash $ phpunit, <sub>(*21)</sub>

Happy coding!, <sub>(*22)</sub>

Credits

• Phil Sturgeon for documentation format. Stole!

License

The MIT License (MIT). Please see License File for more information., <sub>(*23)</sub>