libredte /
libredte-lib-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like FirmaElectronica often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FirmaElectronica, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class FirmaElectronica |
||
| 33 | { |
||
| 34 | |||
| 35 | private $config; ///< Configuración de la firma electrónica |
||
| 36 | private $certs; ///< Certificados digitales de la firma |
||
| 37 | private $data; ///< Datos del certificado digial |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Constructor para la clase: crea configuración y carga certificado digital |
||
| 41 | * |
||
| 42 | * Si se desea pasar una configuración específica para la firma electrónica |
||
| 43 | * se debe hacer a través de un arreglo con los índices file y pass, donde |
||
| 44 | * file es la ruta hacia el archivo .p12 que contiene tanto la clave privada |
||
| 45 | * como la pública y pass es la contraseña para abrir dicho archivo. |
||
| 46 | * Ejemplo: |
||
| 47 | * |
||
| 48 | * \code{.php} |
||
| 49 | * $firma_config = ['file'=>'/ruta/al/certificado.p12', 'pass'=>'contraseña']; |
||
| 50 | * $firma = new \sasco\LibreDTE\FirmaElectronica($firma_config); |
||
| 51 | * \endcode |
||
| 52 | * |
||
| 53 | * También se permite que en vez de pasar la ruta al certificado p12 se pase |
||
| 54 | * el contenido del certificado, esto servirá por ejemplo si los datos del |
||
| 55 | * archivo están almacenados en una base de datos. Ejemplo: |
||
| 56 | * |
||
| 57 | * \code{.php} |
||
| 58 | * $firma_config = ['data'=>file_get_contents('/ruta/al/certificado.p12'), 'pass'=>'contraseña']; |
||
| 59 | * $firma = new \sasco\LibreDTE\FirmaElectronica($firma_config); |
||
| 60 | * \endcode |
||
| 61 | * |
||
| 62 | * @param config Configuración para la clase, si no se especifica se tratará de determinar |
||
| 63 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 64 | * @version 2015-09-15 |
||
| 65 | */ |
||
| 66 | public function __construct(array $config = []) |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Método para generar un error usando una excepción de SowerPHP o terminar |
||
| 102 | * el script si no se está usando el framework |
||
| 103 | * @param msg Mensaje del error |
||
| 104 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 105 | * @version 2017-08-04 |
||
| 106 | */ |
||
| 107 | private function error($msg) |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Método que agrega el inicio y fin de un certificado (clave pública) |
||
| 120 | * @param cert Certificado que se desea normalizar |
||
| 121 | * @return Certificado con el inicio y fin correspondiente |
||
| 122 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 123 | * @version 2015-08-20 |
||
| 124 | */ |
||
| 125 | private function normalizeCert($cert) |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Método que entrega el RUN/RUT asociado al certificado |
||
| 138 | * @return RUN/RUT asociado al certificado en formato: 11222333-4 |
||
| 139 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 140 | * @version 2016-02-12 |
||
| 141 | */ |
||
| 142 | public function getID() |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Método que entrega el CN del subject |
||
| 165 | * @return CN del subject |
||
| 166 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 167 | * @version 2016-02-12 |
||
| 168 | */ |
||
| 169 | public function getName() |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Método que entrega el emailAddress del subject |
||
| 178 | * @return emailAddress del subject |
||
| 179 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 180 | * @version 2016-02-12 |
||
| 181 | */ |
||
| 182 | public function getEmail() |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Método que entrega desde cuando es válida la firma |
||
| 191 | * @return validFrom_time_t |
||
| 192 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 193 | * @version 2015-09-22 |
||
| 194 | */ |
||
| 195 | public function getFrom() |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Método que entrega hasta cuando es válida la firma |
||
| 202 | * @return validTo_time_t |
||
| 203 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 204 | * @version 2015-09-22 |
||
| 205 | */ |
||
| 206 | public function getTo() |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Método que entrega el nombre del emisor de la firma |
||
| 213 | * @return CN del issuer |
||
| 214 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 215 | * @version 2015-09-22 |
||
| 216 | */ |
||
| 217 | public function getIssuer() |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Método que entrega los datos del certificado |
||
| 224 | * @return Arreglo con todo los datos del certificado |
||
| 225 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 226 | * @version 2015-09-11 |
||
| 227 | */ |
||
| 228 | public function getData() |
||
| 232 | |||
| 233 | /** |
||
| 234 | * Método que obtiene el módulo de la clave privada |
||
| 235 | * @return Módulo en base64 |
||
| 236 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 237 | * @version 2014-12-07 |
||
| 238 | */ |
||
| 239 | public function getModulus() |
||
| 244 | |||
| 245 | /** |
||
| 246 | * Método que obtiene el exponente público de la clave privada |
||
| 247 | * @return Exponente público en base64 |
||
| 248 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 249 | * @version 2014-12-06 |
||
| 250 | */ |
||
| 251 | public function getExponent() |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Método que entrega el certificado de la firma |
||
| 259 | * @return Contenido del certificado, clave pública del certificado digital, en base64 |
||
| 260 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 261 | * @version 2015-08-24 |
||
| 262 | */ |
||
| 263 | View Code Duplication | public function getCertificate($clean = false) |
|
| 275 | |||
| 276 | /** |
||
| 277 | * Método que entrega la clave privada de la firma |
||
| 278 | * @return Contenido de la clave privada del certificado digital en base64 |
||
| 279 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 280 | * @version 2015-08-24 |
||
| 281 | */ |
||
| 282 | View Code Duplication | public function getPrivateKey($clean = false) |
|
| 294 | |||
| 295 | /** |
||
| 296 | * Método para realizar la firma de datos |
||
| 297 | * @param data Datos que se desean firmar |
||
| 298 | * @param signature_alg Algoritmo que se utilizará para firmar (por defect SHA1) |
||
| 299 | * @return Firma digital de los datos en base64 o =false si no se pudo firmar |
||
| 300 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 301 | * @version 2014-12-08 |
||
| 302 | */ |
||
| 303 | public function sign($data, $signature_alg = OPENSSL_ALGO_SHA1) |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Método que verifica la firma digital de datos |
||
| 314 | * @param data Datos que se desean verificar |
||
| 315 | * @param signature Firma digital de los datos en base64 |
||
| 316 | * @param pub_key Certificado digital, clave pública, de la firma |
||
| 317 | * @param signature_alg Algoritmo que se usó para firmar (por defect SHA1) |
||
| 318 | * @return =true si la firma está ok, =false si está mal o no se pudo determinar |
||
| 319 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 320 | * @version 2014-12-08 |
||
| 321 | */ |
||
| 322 | public function verify($data, $signature, $pub_key = null, $signature_alg = OPENSSL_ALGO_SHA1) |
||
| 329 | |||
| 330 | /** |
||
| 331 | * Método que firma un XML utilizando RSA y SHA1 |
||
| 332 | * |
||
| 333 | * Referencia: http://www.di-mgt.com.au/xmldsig2.html |
||
| 334 | * |
||
| 335 | * @param xml Datos XML que se desean firmar |
||
| 336 | * @param reference Referencia a la que hace la firma |
||
| 337 | * @return XML firmado o =false si no se pudo fimar |
||
| 338 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 339 | * @version 2017-10-22 |
||
| 340 | */ |
||
| 341 | public function signXML($xml, $reference = '', $tag = null, $xmlns_xsi = false) |
||
| 436 | |||
| 437 | /** |
||
| 438 | * Método que verifica la validez de la firma de un XML utilizando RSA y SHA1 |
||
| 439 | * @param xml_data Archivo XML que se desea validar |
||
| 440 | * @return =true si la firma del documento XML es válida o =false si no lo es |
||
| 441 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 442 | * @version 2015-09-02 |
||
| 443 | */ |
||
| 444 | public function verifyXML($xml_data, $tag = null) |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Método que obtiene la clave asociada al módulo y exponente entregados |
||
| 471 | * @param modulus Módulo de la clave |
||
| 472 | * @param exponent Exponente de la clave |
||
| 473 | * @return Entrega la clave asociada al módulo y exponente |
||
| 474 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 475 | * @version 2015-09-19 |
||
| 476 | */ |
||
| 477 | public static function getFromModulusExponent($modulus, $exponent) |
||
| 486 | |||
| 487 | } |
||
| 488 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.