Dove si trova la documentazione di OpenSSL?

3

Ho notato un sacco di odio per OpenSSL a causa della sua mancanza di documentazione. E tutti i consigli e le guide sulla biblioteca devono essere trasmessi al nostro popolo attraverso il canto e la storia.

Dubito sempre di me stesso, perché come potrebbero centinaia di persone dedicare così tanto tempo a questo meraviglioso lavoro di ingegneria se non annotano nemmeno quello che fanno? La documentazione ufficiale è una mera leggenda ora? Certo, c'è openssl.org e la documentazione in pdf; tuttavia non è funzione per funzione, la documentazione si limita a proiettare gruppi di funzioni alla volta.

Ad esempio, sto cercando di capire come usare la funzione AES_set_encrypt_key(const unsigned char *userKey, const int bits,AES_KEY *key); .

  • Il file di intestazione contiene 0 righe di documentazione,
  • Il sito Web non riconosce la sua esistenza,
  • Il PDF dice che la funzione esiste, ma mi risparmia persino i dettagli di quali sono gli elementi, rendendo il file di intestazione più prezioso

Potrebbe semplicemente essere che dovrei sapere automaticamente cosa fa questa funzione. Non sono così intelligente, anzi, ma tutto sommato anche se aggiunge attrito quando cerco di imparare questa roba.

Perché una documentazione importante come questa scompare / cessa di esistere?

    
posta Sanchke Dellowar 17.11.2016 - 03:38
fonte

1 risposta

2

Why does important documentation like this disappear/cease to exist?

Perché questo è un mondo imperfetto pieno di persone imperfette che fanno cose imperfette, imperfettamente.

Un po 'di ricerca su google mostra che aveva questa intestazione e una firma leggermente diversa.

/* AES_set_encrypt_key configures |aeskey| to encrypt with the |bits|-bit key,
 * |key|.
 *
 * WARNING: unlike other OpenSSL functions, this returns zero on success and a
 * negative number on error. */
OPENSSL_EXPORT int AES_set_encrypt_key(const uint8_t *key, unsigned bits,
                                       AES_KEY *aeskey);

Ma dal momento che le intestazioni non vengono compilate spesso perdono il refactoring. Con il cambio di firma, potrebbe essere successo qui. E potrebbero aver capito che le intestazioni non erano più aggiornate, quindi le hanno semplicemente rimosse.

Perciò ti dirò di fare qui ciò che dovresti fare con tutta la documentazione: usa con cautela.

    
risposta data 17.11.2016 - 04:30
fonte

Leggi altre domande sui tag