b3da/eos-bundle

Symfony bundle for easy OpenSSL operations

b3da/EasyOpenSslBundle

Symfony Bundle for easy OpenSSL encryption, decryption and key pair generation.

Dependencies:

• symfony/framework-standard-edition ">=2.8|~3.1"

Instalation:

• create project with Symfony framework, _(*1)

• composer require b3da/eos-bundle "dev-master", _(*2)

• AppKernel.php:, _(*3)

  new b3da\EasyOpenSslBundle\b3daEasyOpenSslBundle(),
    

• parameters.yml(.dist):, _(*4)

  # EasyOpenSSL encryption method
    eos_enc_method: aes-256-cbc
    # ...
    

• (you can extend base Client and Message entities from b3da\EasyOpenSslBundle namespace), _(*5)

• update your schema, _(*6)

Usage:

• new service b3da_easy_open_ssl.eos is available for OpenSSL operations, _(*7)

  $eos = $this->get('b3da_easy_open_ssl.eos');
    

• create Client example (FooController), _(*8)

  $client = new Client();
    $client = $eos->generateKeyPairForClient($client);
    if (!$client) {
       // err generating keypair
    }
    // persist Client with keys
    

• encrypt data by Client's private key example (FooController), _(*9)

  $message = $eos->encrypt($client, 'msg data .. foo bar baz');
    

• decrypt data by Client's public key example (FooController), _(*10)

  $decryptedData = $eos->decrypt($message);
    // $decryptedData === 'msg data .. foo bar baz';
    

simple API for basic tasks (optional)

• import routes into routing.yml:, _(*11)

  b3da_easy_open_ssl:
        resource: "@b3daEasyOpenSslBundle/Controller/"
        type:     annotation
        prefix:   /eos/
    

• /eos/msg-api/client/create/ [POST], _(*12)

  Response:
    
    {"status":"success","id":"3ead5521-2fbc-11e6-834a-f0def1ff5901"}
    
    or
    
    {"status":"error","details":"key pair generating failed"}
    

• /eos/msg-api/client/export-public/{id}/ [GET], _(*13)

  Response:
    
    {"status":"success","data":{"id":"3ead5521-2fbc-11e6-834a-f0def1ff5901","pubkey":"LS0tLS1CR .. S0tLQ=="}}
    
    or
    
    {"status":"error","details":"no client for id"}
    

• /eos/msg-api/client/import-public/{id}/ [POST], _(*14)

  Request:
    
    {"data":{"id":"3ead5521-2fbc-11e6-834a-f0def1ff5901","pubkey":"LS0tLS1CR .. S0tLQ=="}}
    
    Response:
    
    {"status":"success","id":"3ead5521-2fbc-11e6-834a-f0def1ff5901"}
    
    or
    
    {"status":"error","details":"no data to import"}
    

• /eos/msg-api/msg/encrypt/{clientId}/{data}/ [GET], _(*15)

  Response:
    
    {"status":"success","data":{"message":":774c6b663650636 .. 34346616f5901"}}
    
    or
    
    {"status":"error","details":"no client for id"}
    

• /eos/msg-api/msg/decrypt/{data}/ [GET], _(*16)

  Request:
    
    /eos/msg-api/msg/decrypt/{"message":":774c6b663650636 .. 34346616f5901"}/
    
    Response:
    
    {"status":"success","data":"foo bar"}
    
    or
    
    {"status":"error","details":"wrong format"}