Merge pull request #1 from eclipxe13/master

eclipxe13 · web-flow · commit be53995f831a · 2019-09-18T17:22:48.000-05:00
Version 1.0.1
diff --git a/.gitattributes b/.gitattributes
@@ -13,7 +13,9 @@
 /.gitattributes         export-ignore
 /.gitignore             export-ignore
 /.php_cs.dist           export-ignore
+/.phplint.yml           export-ignore
 /.scrutinizer.yml       export-ignore
 /.travis.yml            export-ignore
 /phpcs.xml.dist         export-ignore
+/phpstan.neon.dist      export-ignore
 /phpunit.xml.dist       export-ignore
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -5,14 +5,7 @@ filter:
 
 build:
   nodes:
-    php73:
-      environment:
-        php:
-          version: "7.3"
-          # pecl_extensions: # add if there is an extension not present on scrutinizer
-          #  - "zip"
-      project_setup: # see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/
-        override: true
+    php:
       tests:
         override:
           - php-scrutinizer-run --enable-security-analysis
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,11 @@
 language: php
 
 # php compatibility
-php:
-  - "7.2"
-  - "7.3"
+php: ["7.2", "7.3", "7.4snapshot"]
+
+matrix:
+  allow_failures:
+    - php: "7.4snapshot"
 
 # This triggers builds to run on the new TravisCI infrastructure.
 # See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
@@ -14,7 +16,7 @@ cache:
     - $HOME/.composer
 
 before_script:
-  - phpenv config-rm xdebug.ini
+  - phpenv config-rm xdebug.ini || true
   - travis_retry composer install --no-interaction --prefer-dist
   - mkdir -p build
 
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Carlos C Soto
+Copyright (c) 2019 PHPCFDI
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -80,7 +80,7 @@ y recuerda revisar el archivo de tareas pendientes [TODO][] y el [CHANGELOG][].
 
 ## Copyright and License
 
-The phpcfdi/credentials library is copyright © [Carlos C Soto](http://eclipxe.com.mx/)
+The phpcfdi/finkok library is copyright © [PhpCfdi](https://github.com/phpcfdi)
 and licensed for use under the MIT License (MIT). Please see [LICENSE][] for more information.
 
 [contributing]: https://github.com/phpcfdi/credentials/blob/master/CONTRIBUTING.md
diff --git a/composer.json b/composer.json
@@ -14,6 +14,7 @@
     "require": {
         "php": ">=7.2",
         "ext-openssl": "*",
+        "ext-mbstring": "*",
         "eclipxe/enum": "^0.2.0"
     },
     "require-dev": {
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,15 +1,18 @@
 # CHANGELOG
 
-## About SemVer
+:us: changes are documented in spanish as it help intented audience to follow changes
 
-In summary, [SemVer](https://semver.org/) can be viewed as ` Breaking . Feature . Fix `, where:
+:mexico: los cambios están documentados en español para mejor entendimiento
 
-- Breaking version = includes incompatible changes to the API
-- Feature version = adds new feature(s) in a backwards-compatible manner
-- Fix version = includes backwards-compatible bug fixes
+Nos apegamos a [SEMVER](SEMVER.md), revisa la información para entender mejor el control de versiones.
+
+## Version 1.0.1 2019-09-18
+
+- Agregar métodos a `PrivateKey` para poder exponer la llave privada en formato PEM y la frase de paso.
+- Traducir documentación en `docs/` a español
 
 ## Version 1.0.0 2019-08-13
 
-- Initial working release
-- Projects phpcfdi/xml-cancelacion and phpcfdi/sat-ws-descarga-masiva are using this project as dependence,
-  the implementation on both projects give clues to improve before first stable release.
+- Primera versión funcional
+- Los proyectos `phpcfdi/xml-cancelacion` y `phpcfdi/sat-ws-descarga-masiva` tienen este proyecto como dependencia,
+  la implementación en ambos proyectos dan algunas pistas de cómo mejorar este proyecto.
diff --git a/docs/SEMVER.md b/docs/SEMVER.md
@@ -0,0 +1,45 @@
+# SEMVER
+
+Respetamos el estándar [Versionado Semántico 2.0.0](https://semver.org/lang/es/).
+
+En resumen, [SemVer](https://semver.org/) es un sistema de versiones de tres componentes `X.Y.Z`
+que nombraremos así: `[ Breaking ] . [ Feature ] . [ Fix ]`, donde:
+
+- `Breaking`: Rompe la compatibilidad de código con versiones anteriores.
+- `Feature`: Agrega una nueva característica que es compatible con lo anterior.
+- `Fix`: Incluye algún cambio (generalmente correcciones) que no agregan nueva funcionalidad.
+
+## Composer
+
+[Composer](https://getcomposer.org/) es un gestor de dependencias en proyectos para PHP.
+Este gestor usa las [reglas](https://getcomposer.org/doc/articles/versions.md)
+de versionado semántico para instalar y actualizar paquetes.
+
+Te recomendamos instalar dependencias de librerías (no frameworks) con *Caret Version Range*.
+Por ejemplo: `"vendor/package": "^2.5"`.
+
+Esto significa que:
+
+- no debe actualizar a versiones `3.x.x`
+- no debe utilizar ninguna versión menor a `2.5.0`
+
+## Versiones 0.x.y no rompe compatibilidad
+
+Las versiones que inician con cero, por ejemplo `0.y.z`, no se ajustan a las reglas de versionado.
+Se considera que estas versiones son previas a la madurez del proyecto y por lo tanto
+introducen cambios sin previo aviso.
+
+Sin embargo, nos apegaremos a `[ 0 ] . [ Breaking ] . [ Feature || Fix ]`. Lo que significa que `0.3.0`
+no es compatible con `0.2.15` pero `0.3.4` sí es compatible con `0.3.0`.
+
+## `@internal` no rompe compatibilidad
+
+Si la librería contiene elementos marcados como `@internal` significa que no deben ser utilizados
+por tu código. Son partes de código internos de la librería.
+Por lo tanto, no se consideran breaking changes.
+
+Cuando un elemento es `@internal`, dicho elemento:
+
+- no debe ser una entrada (parámetro)
+- no debe ser una salida (retorno)
+- no debe exponer exponer funcionalidades en los objetos públicos (rasgos)
diff --git a/docs/TODO.md b/docs/TODO.md
@@ -1,10 +1,8 @@
-# phpcfdi/credentials To Do List
-
-- Find out how to differentiate betwen a CSD and a FIEL
-    - By existence of subject.OU ?
-    - By existence of subject.email ?
-    - By extensions.keyUsage ?
-    - By extensions.extendedKeyUsage ?
-    - By purposes[2] is [CSD/FIEL, false, sslserver] ? 
+# phpcfdi/credentials Tareas pendientes
 
+- [X] Encontrar como diferenciar entre un archivo CSD y un archivo FIEL
+  R: Se identifica por el campo OU (Organization Unit / Sucursal) del certificado, si está vacío es FIEL,
+  si tiene contenido es CSD. 
 
+- [ ] Verificar si un certificado fue realmente emitido por el SAT
+  Ver [VerificacionCertificadosSAT](VerificacionCertificadosSAT.md)
diff --git a/src/Internal/BaseConverter.php b/src/Internal/BaseConverter.php
@@ -52,7 +52,7 @@ public function convert(string $input, int $frombase, int $tobase): string
 
         $originalSequence = $this->sequence()->value();
         if ('' === $input) {
-            $input = $originalSequence{0}; // use zero as input
+            $input = $originalSequence[0]; // use zero as input
         }
         $chars = substr($originalSequence, 0, $frombase);
         if (! boolval(preg_match("/^[$chars]+$/", $input))) {
@@ -62,7 +62,7 @@ public function convert(string $input, int $frombase, int $tobase): string
         $length = strlen($input);
         $values = [];
         for ($i = 0; $i < $length; $i++) {
-            $values[] = intval(stripos($originalSequence, $input{$i}));
+            $values[] = intval(stripos($originalSequence, $input[$i]));
         }
 
         $result = '';
@@ -81,7 +81,7 @@ public function convert(string $input, int $frombase, int $tobase): string
                 }
             }
             $length = $newlen;
-            $result = $originalSequence{$divide} . $result;
+            $result = $originalSequence[$divide] . $result;
         } while ($newlen > 0);
 
         return $result;
diff --git a/src/PrivateKey.php b/src/PrivateKey.php
@@ -14,8 +14,8 @@ class PrivateKey extends Key
 {
     use LocalFileOpenTrait;
 
-    /** @var string PEM contents of private key*/
-    private $key;
+    /** @var string PEM contents of private key */
+    private $pem;
 
     /** @var string */
     private $passPhrase;
@@ -33,7 +33,7 @@ public function __construct(string $source, string $passPhrase)
         if ('' === $source) {
             throw new UnexpectedValueException('Private key is not PEM');
         }
-        $this->key = $source;
+        $this->pem = $source;
         $this->passPhrase = $passPhrase;
         $dataArray = $this->callOnPrivateKey(
             function ($privateKey): array {
@@ -49,6 +49,16 @@ public static function openFile(string $filename, string $passPhrase): self
         return new self(static::localFileOpen($filename), $passPhrase);
     }
 
+    public function pem(): string
+    {
+        return $this->pem;
+    }
+
+    public function passPhrase(): string
+    {
+        return $this->passPhrase;
+    }
+
     public function publicKey(): PublicKey
     {
         if (null === $this->publicKey) {
@@ -59,8 +69,8 @@ public function publicKey(): PublicKey
 
     public function sign(string $data, int $algorithm = OPENSSL_ALGO_SHA256): string
     {
-        return (string) $this->callOnPrivateKey(
-            function ($privateKey) use ($data, $algorithm) {
+        return $this->callOnPrivateKey(
+            function ($privateKey) use ($data, $algorithm): string {
                 if (false === $this->openSslSign($data, $signature, $privateKey, $algorithm)) {
                     throw new RuntimeException('Cannot sign data: ' . openssl_error_string());
                 }
@@ -107,7 +117,7 @@ function ($privateKey) use ($certificate): bool {
      */
     public function callOnPrivateKey(Closure $function)
     {
-        $privateKey = openssl_get_privatekey($this->key, $this->passPhrase);
+        $privateKey = openssl_get_privatekey($this->pem(), $this->passPhrase());
         if (! is_resource($privateKey)) {
             throw new RuntimeException('Cannot open private key: ' . openssl_error_string());
         }
diff --git a/src/PublicKey.php b/src/PublicKey.php
@@ -43,7 +43,7 @@ public static function openFile(string $filename): self
      */
     public function verify(string $data, string $signature, int $algorithm = OPENSSL_ALGO_SHA256): bool
     {
-        return (bool) $this->callOnPublicKey(
+        return $this->callOnPublicKey(
             function ($publicKey) use ($data, $signature, $algorithm): bool {
                 $verify = $this->openSslVerify($data, $signature, $publicKey, $algorithm);
                 if (-1 === $verify) {
diff --git a/tests/Unit/PrivateKeyTest.php b/tests/Unit/PrivateKeyTest.php
@@ -19,6 +19,17 @@ public function createPrivateKey(): PrivateKey
         return PrivateKey::openFile($filename, $password);
     }
 
+    public function testPemAndPassPhraseProperties(): void
+    {
+        $passPhrase = trim($this->fileContents('FIEL_AAA010101AAA/password.txt'));
+        $fileContents = $this->fileContents('FIEL_AAA010101AAA/private_key_protected.key.pem');
+        $privateKey = new PrivateKey($fileContents, $passPhrase);
+        $this->assertStringContainsString($privateKey->pem(), $fileContents);
+        $this->assertStringStartsWith('-----BEGIN RSA PRIVATE KEY-----', $privateKey->pem());
+        $this->assertStringEndsWith('-----END RSA PRIVATE KEY-----', $privateKey->pem());
+        $this->assertSame($passPhrase, $privateKey->passPhrase());
+    }
+
     public function testPublicKeyIsTheSameAsInCertificate(): void
     {
         $cerfile = $this->filePath('FIEL_AAA010101AAA/certificate.cer');

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function convert(string $input, int $frombase, int $tobase): string`
`52`	`52`
`53`	`53`	`$originalSequence = $this->sequence()->value();`
`54`	`54`	`if ('' === $input) {`
`55`		`- $input = $originalSequence{0}; // use zero as input`
	`55`	`+ $input = $originalSequence[0]; // use zero as input`
`56`	`56`	`}`
`57`	`57`	`$chars = substr($originalSequence, 0, $frombase);`
`58`	`58`	`if (! boolval(preg_match("/^[$chars]+$/", $input))) {`
`@@ -62,7 +62,7 @@ public function convert(string $input, int $frombase, int $tobase): string`
`62`	`62`	`$length = strlen($input);`
`63`	`63`	`$values = [];`
`64`	`64`	`for ($i = 0; $i < $length; $i++) {`
`65`		`- $values[] = intval(stripos($originalSequence, $input{$i}));`
	`65`	`+ $values[] = intval(stripos($originalSequence, $input[$i]));`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`$result = '';`
`@@ -81,7 +81,7 @@ public function convert(string $input, int $frombase, int $tobase): string`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`	`$length = $newlen;`
`84`		`- $result = $originalSequence{$divide} . $result;`
	`84`	`+ $result = $originalSequence[$divide] . $result;`
`85`	`85`	`} while ($newlen > 0);`
`86`	`86`
`87`	`87`	`return $result;`