|
| 1 | +<div align="right"> |
| 2 | + <h6> |
| 3 | + <picture> |
| 4 | + <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/white/icon32.svg"> |
| 5 | + <img height=14 src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/earth-icon/black/icon32.svg"> |
| 6 | + </picture> |
| 7 | + Español | |
| 8 | + <a href="../..#readme">English</a> | |
| 9 | + <a href="../zh-cn#readme">简体中文</a> | |
| 10 | + <a href="../zh-tw#readme">繁體中文</a> | |
| 11 | + <a href="../hi#readme">हिंदी</a> | |
| 12 | + <a href="../bn#readme">বাংলা</a> |
| 13 | + </h6> |
| 14 | +</div> |
| 15 | + |
| 16 | +# > generate-pw |
| 17 | + |
| 18 | +### Genere, fortalezca y valide aleatoriamente contraseñas criptográficamente seguras. |
| 19 | + |
| 20 | +<a href="#%EF%B8%8F-licencia-mit"><img height=31 src="https://img.shields.io/badge/Licencia-MIT-orange.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a> |
| 21 | +<a href="https://github.com/adamlui/js-utils/releases/tag/generate-pw-1.4.2"><img height=31 src="https://img.shields.io/badge/Ultima_Versión-1.4.2-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a> |
| 22 | +<a href="https://www.npmjs.com/package/generate-pw?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/generate-pw?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue&label=Tama%C3%B1o%20Desempaquetado"></a> |
| 23 | +<a href="https://github.com/adamlui/js-utils/blob/generate-pw-1.4.2/generate-pw/dist/generate-pw.min.js"><img height=31 src="https://img.shields.io/github/size/adamlui/js-utils/generate-pw/dist/generate-pw.min.js?branch=generate-pw-1.4.2&label=Tama%C3%B1o%20Minimizado&logo=databricks&logoColor=white&labelColor=464646&color=ff69b4&style=for-the-badge"></a> |
| 24 | +<a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:generate-pw/src/generate-pw.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Agenerate-pw%2Fsrc%2Fgenerate-pw.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilidades&color=gold"></a> |
| 25 | + |
| 26 | +<br> |
| 27 | + |
| 28 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 29 | + |
| 30 | +## 💡 Acerca de |
| 31 | + |
| 32 | +**generate-pw** es una biblioteca liviana y fácil de usar que le permite generar, fortalecer y validar aleatoriamente contraseñas criptográficamente seguras. |
| 33 | + |
| 34 | +- **Sin dependencias externas —** Solo se utilizan métodos criptográficos integrados para una aleatorización segura |
| 35 | +- **Altamente personalizable:** Especifique la longitud, la cantidad, los juegos de caracteres a usar, etc. |
| 36 | +- **Compatibilidad con múltiples entornos:** Uso en Node.js o el navegador web |
| 37 | +- **Línea de comando utilizable —** Simplemente escriba `generate-pw`, eso es todo |
| 38 | + |
| 39 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 40 | + |
| 41 | +## ⚡ Instalación |
| 42 | + |
| 43 | +Como **utilidad global**: |
| 44 | + |
| 45 | +``` |
| 46 | +$ npm install -g generate-pw |
| 47 | +``` |
| 48 | + |
| 49 | +Como **dependencia de tiempo de ejecución**, desde la raíz de tu proyecto: |
| 50 | + |
| 51 | +``` |
| 52 | +$ npm install generate-pw |
| 53 | +``` |
| 54 | + |
| 55 | +<br> |
| 56 | + |
| 57 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 58 | + |
| 59 | +## 🔌 Importando la API |
| 60 | + |
| 61 | +### <img height=18 src="https://i.imgur.com/JIeAdsr.png"> Node.js |
| 62 | + |
| 63 | +#### ES module*: |
| 64 | + |
| 65 | +```js |
| 66 | +import * as pw from 'generate-pw'; |
| 67 | +``` |
| 68 | + |
| 69 | +#### CommonJS: |
| 70 | + |
| 71 | +```js |
| 72 | +const pw = require('generate-pw'); |
| 73 | +``` |
| 74 | + |
| 75 | +###### _*Se requiere Node.js versión 14 o superior_ |
| 76 | + |
| 77 | +### <picture><source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/JSEb19A.png"><img width=16 src="https://i.imgur.com/5VPxf9y.png"></picture> Web |
| 78 | + |
| 79 | +#### <> Etiqueta de secuencia de comandos HTML: |
| 80 | + |
| 81 | +```html |
| 82 | +<script src="https://cdn.jsdelivr.net/npm/generate-pw@1.4.2/dist/generate-pw.min.js"></script> |
| 83 | +``` |
| 84 | + |
| 85 | +#### ES6: |
| 86 | + |
| 87 | +```js |
| 88 | +(async () => { |
| 89 | + await import('https://cdn.jsdelivr.net/npm/generate-pw@1.4.2/dist/generate-pw.min.js'); |
| 90 | + // Tu código aquí... |
| 91 | +})(); |
| 92 | +``` |
| 93 | + |
| 94 | +### <img height=17 src="https://raw.githubusercontent.com/KudoAI/chatgpt.js/main/starters/media/images/icons/tampermonkey-icon28.png"><img height=17.5 src="https://raw.githubusercontent.com/KudoAI/chatgpt.js/main/starters/media/images/icons/violentmonkey-icon100.png"> Greasemonkey |
| 95 | + |
| 96 | +```js |
| 97 | +... |
| 98 | +// @require https://cdn.jsdelivr.net/npm/generate-pw@1.4.2/dist/generate-pw.min.js |
| 99 | +// ==/UserScript== |
| 100 | + |
| 101 | +// Tu código aquí... |
| 102 | +``` |
| 103 | + |
| 104 | +<br> |
| 105 | + |
| 106 | +**💡 Nota:** Para importar siempre la última versión (¡no se recomienda en producción!), elimine la etiqueta de versión `@1.4.2` de la URL de jsDelivr: `https://cdn.jsdelivr.net/npm/generate-pw/dist/generate-pw.min.js` |
| 107 | + |
| 108 | +<br> |
| 109 | + |
| 110 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 111 | + |
| 112 | +## 📋 Uso de API |
| 113 | + |
| 114 | +### `generatePassword([opciones])` |
| 115 | + |
| 116 | +Genera **una** contraseña si no se proporciona la opción `qty` y devuelve una cadena: |
| 117 | + |
| 118 | +```js |
| 119 | +const contraseña = pw.generatePassword({ length: 11, numbers: true }); |
| 120 | +console.log(contraseña); // salida de muestra: 'bAsZm3mq6Qn' |
| 121 | +``` |
| 122 | + |
| 123 | +...o **múltiples** contraseñas si se proporciona la opción `qty`, devolviendo una matriz de cadenas: |
| 124 | + |
| 125 | +```js |
| 126 | +const contraseñas = pw.generatePassword({ qty: 5, length: 8, symbols: true }); |
| 127 | +console.log(contraseñas); |
| 128 | + |
| 129 | +/* salida de muestra: |
| 130 | +
|
| 131 | +generatePassword() » Generating passwords... |
| 132 | +generatePassword() » Passwords generated! |
| 133 | +generatePassword() » Check returned array. |
| 134 | +[ '!zSf@Q.s', '!,HT\\;m=', '?Lq&FV>^', 'gf}Y;}Ne', 'Stsx(GqE' ] |
| 135 | +*/ |
| 136 | +``` |
| 137 | + |
| 138 | +**💡 Nota:** Si no se pasan opciones, las contraseñas tendrán 8 caracteres y estarán compuestas por letras mayúsculas y minúsculas. |
| 139 | + |
| 140 | +Ver: [Opciones disponibles](#opciones-disponibles-para-funciones-generate) |
| 141 | + |
| 142 | +# |
| 143 | + |
| 144 | +### `generatePasswords(qty[, opciones])` |
| 145 | + |
| 146 | +Genera **múltiples** contraseñas basadas en la `qty` dada y devuelve una matriz de cadenas: |
| 147 | + |
| 148 | +```js |
| 149 | +const contraseñas = pw.generatePasswords(5, { length: 3, uppercase: false }); |
| 150 | +console.log(contraseñas); |
| 151 | + |
| 152 | +/* salida de muestra: |
| 153 | +
|
| 154 | +generatePasswords() » Generating passwords... |
| 155 | +generatePasswords() » Passwords generated! |
| 156 | +generatePasswords() » Check returned array. |
| 157 | +[ 'yilppxru', 'ckvkyjfp', 'zolcpyfb' ] |
| 158 | +*/ |
| 159 | +``` |
| 160 | + |
| 161 | +**💡 Nota:** Si no se pasa ningún argumento `qty`, solo se generará una contraseña, devuelta como una cadena. |
| 162 | + |
| 163 | +Ver: [Opciones disponibles](#opciones-disponibles-para-funciones-generate) |
| 164 | + |
| 165 | +# |
| 166 | + |
| 167 | +### `strictify(contraseña[, tiposCarRequeridos, opciones])` |
| 168 | + |
| 169 | +Modifica la `contraseña` dada para usar al menos un carácter de cada elemento `requiredCharTypes` pasado, devolviendo una cadena: |
| 170 | + |
| 171 | +```js |
| 172 | +const strictPW = pw.strictify('abcdef', ['numbers', 'symbols']); |
| 173 | +console.log(strictPW); // sample output: 'a!c2ef' |
| 174 | +``` |
| 175 | + |
| 176 | +**💡 Nota:** Si no se pasa ninguna matriz `tiposCarRequeridos`, se requerirán todos los tipos disponibles. |
| 177 | + |
| 178 | +Los `tiposCarRequeridos` disponibles son: `['número', 'símbolo', 'inferior', 'superior']` |
| 179 | + |
| 180 | +Opciones disponibles (pasadas como propiedades del objeto): |
| 181 | + |
| 182 | +Nombre | Tipo | Descripción | Valor por Defecto |
| 183 | +----------|----------|-------------------------------------------|------------------- |
| 184 | +`verbose` | Booleano | Mostrar registros en la consola/terminal. | `true` |
| 185 | + |
| 186 | +# |
| 187 | + |
| 188 | +### `validateStrength(contraseña[, opciones])` |
| 189 | + |
| 190 | +Valida la seguridad de una contraseña y devuelve un objeto que contiene: |
| 191 | +- `strengthScore` (0–100) |
| 192 | +- matriz `recommendations` |
| 193 | +- `isGood` booleano (`true` si `strengthScore` >= 80) |
| 194 | + |
| 195 | +Ejemplo: |
| 196 | + |
| 197 | +```js |
| 198 | +const fortalezaPW = pw.validateStrength('Aa?idsE'); |
| 199 | +console.log(fortalezaPW); |
| 200 | + |
| 201 | +/* salidas: |
| 202 | +
|
| 203 | +validateStrength() » Validating password strength... |
| 204 | +validateStrength() » Password strength validated! |
| 205 | +validateStrength() » Check returned object for score/recommendations. |
| 206 | +{ |
| 207 | + strengthScore: 60, |
| 208 | + recommendations: [ |
| 209 | + 'Make it at least 8 characters long.', |
| 210 | + 'Include at least one number.' |
| 211 | + ], |
| 212 | + isGood: false |
| 213 | +} |
| 214 | +*/ |
| 215 | +``` |
| 216 | + |
| 217 | +Opciones disponibles (pasadas como propiedades del objeto): |
| 218 | + |
| 219 | +Nombre | Tipo | Descripción | Valor por Defecto |
| 220 | +----------|----------|-------------------------------------------|------------------- |
| 221 | +`verbose` | Booleano | Mostrar registros en la consola/terminal. | `true` |
| 222 | + |
| 223 | +# |
| 224 | + |
| 225 | +### Opciones disponibles para funciones `generate*()` |
| 226 | + |
| 227 | +Cualquiera de estos se puede pasar al objeto de opciones para cada función `generate*()`: |
| 228 | + |
| 229 | +Nombre | Tipo | Descripción | Valor por Defecto |
| 230 | +------------|----------|----------------------------------------------------------------------------------------------|--------------- |
| 231 | +`verbose` | Booleano | Mostrar registros en la consola/terminal. | `true` |
| 232 | +`length` | Entero | Longitud de la(s) contraseña(s). | `8` |
| 233 | +`qty`* | Entero | Número de contraseñas a generar. | `1` |
| 234 | +`charset` | Cadena | Caracteres a incluir en la(s) contraseña(s). | `''` |
| 235 | +`exclude` | Cadena | Caracteres para excluir de la(s) contraseña(s). | `''` |
| 236 | +`numbers` | Booleano | Permitir números en contraseña(s). | `false` |
| 237 | +`symbols` | Booleano | Permitir símbolos en la(s) contraseña(s). | `false` |
| 238 | +`lowercase` | Booleano | Permitir letras minúsculas en la(s) contraseña(s). | `true` |
| 239 | +`uppercase` | Booleano | Permitir letras mayúsculas en la(s) contraseña(s). | `true` |
| 240 | +`strict` | Booleano | Requiere al menos un carácter de cada carácter permitido establecido en la(s) contraseña(s). | `false` |
| 241 | + |
| 242 | +##### _*Solo disponible en [`generatePassword([opciones])`](#generatepasswordopciones) ya que [`generatePasswords(qty[, opciones])`](#generatepasswordsqty-opciones) toma un argumento `qty`_ |
| 243 | + |
| 244 | +<br> |
| 245 | + |
| 246 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 247 | + |
| 248 | +## 💻 Uso de la línea de comando |
| 249 | + |
| 250 | +Cuando se instala [globalmente](#-instalación), **generate-pw** también se puede usar desde la línea de comando. El comando básico es: |
| 251 | + |
| 252 | +``` |
| 253 | +$ generate-pw |
| 254 | +``` |
| 255 | + |
| 256 | +**💡 Note:** For security reasons, generated password(s) are stored in the clipboard. |
| 257 | + |
| 258 | +# |
| 259 | + |
| 260 | +### Opciones de línea de comando |
| 261 | + |
| 262 | +``` |
| 263 | +Opciones de parámetros: |
| 264 | + --length=n Genere contraseña(s) de n longitud. |
| 265 | + --qty=n Generar n contraseña(s). |
| 266 | + --charset=cars Incluya únicamente cars en las contraseña(s). |
| 267 | + --exclude=cars Excluir cars de las contraseña(s). |
| 268 | +
|
| 269 | +Opciones booleanas: |
| 270 | + -n, --include-numbers Permitir números en contraseña(s). |
| 271 | + -s, --include-symbols Permitir símbolos en las contraseña(s). |
| 272 | + -L, --no-lowercase No permitir letras minúsculas en las contraseña(s). |
| 273 | + -U, --no-uppercase No permitir letras mayúsculas en las contraseña(s). |
| 274 | + -s, --strict Requiere al menos un carácter de cada carácter permitido establecido en las contraseña(s). |
| 275 | + -q, --quiet Suprime todos los registros excepto los errores. |
| 276 | +
|
| 277 | +Comandos de información: |
| 278 | + -h, --help Mostrar pantalla de ayuda. |
| 279 | + -v, --version Mostrar número de versión. |
| 280 | +``` |
| 281 | + |
| 282 | +<br> |
| 283 | + |
| 284 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 285 | + |
| 286 | +## 🏛️ Licencia MIT |
| 287 | + |
| 288 | +**Derechos de autor © 2024 [Adam Lui](https://github.com/adamlui) y contribuyentes** |
| 289 | + |
| 290 | +Por el presente se otorga permiso, sin cargo, a cualquier persona que obtenga una copia de este software y los archivos de documentación asociados (el "Software"), para operar con el Software sin restricciones, incluidos, entre otros, los derechos de uso, copia, modificación, fusión. , publicar, distribuir, sublicenciar y/o vender copias del Software, y permitir que las personas a quienes se les proporciona el Software lo hagan, sujeto a las siguientes condiciones: |
| 291 | + |
| 292 | +El aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software. |
| 293 | + |
| 294 | +EL SOFTWARE SE PROPORCIONA "TAL CUAL", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO PERO NO LIMITADO A LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD PARA UN PROPÓSITO PARTICULAR Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O TITULARES DE DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGÚN RECLAMO, DAÑO U OTRA RESPONSABILIDAD, YA SEA EN UNA ACCIÓN CONTRACTUAL, AGRAVIO O DE OTRA MANERA, QUE SURJA DE, FUERA DE O EN RELACIÓN CON EL SOFTWARE O EL USO U OTRAS NEGOCIOS EN EL SOFTWARE. |
| 295 | + |
| 296 | +<br> |
| 297 | + |
| 298 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 299 | + |
| 300 | +## 🛠️ Utilidades relacionadas |
| 301 | + |
| 302 | +### <img height=21px src="https://i.imgur.com/kvf7fXm.png"> [generate-ip](https://js-utils.com/generate-ip) <a href="https://github.com/toolleeo/cli-apps#networking"><img height=18 src="https://awesome.re/mentioned-badge.svg"></a> |
| 303 | + |
| 304 | +> Generar, formatear y validar aleatoriamente direcciones IPv4/IPv6. |
| 305 | +<br>[Instalar](https://github.com/adamlui/js-utils/tree/main/generate-ip#-installation) / |
| 306 | +[Léame](https://github.com/adamlui/js-utils/tree/main/generate-ip#readme) / |
| 307 | +[Uso de API](https://github.com/adamlui/js-utils/tree/main/generate-ip#-api-usage) / |
| 308 | +[Uso de CLI](https://github.com/adamlui/js-utils/tree/main/generate-ip#-command-line-usage) / |
| 309 | +[Conversar](https://js-utils.com/discussions) |
| 310 | + |
| 311 | +### <a href="https://js-utils.com/geolocate"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/geolocate/media/images/icons/wire-globe/white/icon32.png"><img height=22 src="https://raw.githubusercontent.com/adamlui/js-utils/main/geolocate/media/images/icons/wire-globe/black/icon32.png"></picture> geolocate</a> |
| 312 | + |
| 313 | +> Obtenga datos de geolocalización de IP de la CLI. |
| 314 | +<br>[Instalar](https://github.com/adamlui/js-utils/tree/main/geolocate#-installation) / |
| 315 | +[Léame](https://github.com/adamlui/js-utils/tree/main/geolocate#readme) / |
| 316 | +[Uso de CLI](https://github.com/adamlui/js-utils/tree/main/geolocate#-command-line-usage) / |
| 317 | +[Uso de API](https://github.com/adamlui/js-utils/tree/main/geolocate#-api-usage) / |
| 318 | +[Conversar](https://js-utils.com/discussions) |
| 319 | + |
| 320 | +<br> |
| 321 | + |
| 322 | +<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png"> |
| 323 | + |
| 324 | +<picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/adamlui/js-utils/main/media/images/icons/home/white/icon32x27.png"><img height=11 src="https://raw.githubusercontent.com/adamlui/js-utils/main/media/images/icons/home/dark-gray/icon32x27.png"></picture> <a href="https://js-utils.com">**Más utilidades de JavaScript**</a> / |
| 325 | +<a href="https://js-utils.com/discussions">Conversar</a> / |
| 326 | +<a href="#-generate-pw">Volver arriba ↑</a> |
0 commit comments