diff options
Diffstat (limited to 'doc/microhttpd.texi')
-rw-r--r-- | doc/microhttpd.texi | 280 |
1 files changed, 266 insertions, 14 deletions
diff --git a/doc/microhttpd.texi b/doc/microhttpd.texi index 54ab252a..0c155e47 100644 --- a/doc/microhttpd.texi +++ b/doc/microhttpd.texi | |||
@@ -123,6 +123,7 @@ GNU libmicrohttpd is a GNU package. | |||
123 | * microhttpd-requests:: Handling requests. | 123 | * microhttpd-requests:: Handling requests. |
124 | * microhttpd-responses:: Building responses to requests. | 124 | * microhttpd-responses:: Building responses to requests. |
125 | * microhttpd-post:: Adding a @code{POST} processor. | 125 | * microhttpd-post:: Adding a @code{POST} processor. |
126 | * microhttpd-info:: Obtaining status information. | ||
126 | 127 | ||
127 | Appendices | 128 | Appendices |
128 | 129 | ||
@@ -291,20 +292,6 @@ the @code{struct sockaddr*} should point to a @code{struct sockaddr_in6}, | |||
291 | otherwise to a @code{struct sockaddr_in}. If this option is not specified, | 292 | otherwise to a @code{struct sockaddr_in}. If this option is not specified, |
292 | the daemon will listen to incomming connections from anywhere. | 293 | the daemon will listen to incomming connections from anywhere. |
293 | 294 | ||
294 | @item MHD_OPTION_HTTPS_KEY_PATH | ||
295 | Filename for the private key (key.pem) to be used by the | ||
296 | HTTPS daemon. This option should be followed by an | ||
297 | "const char*" argument. The memory of the filename must | ||
298 | not be released until the application terminates. | ||
299 | This should be used in conjunction with 'MHD_OPTION_HTTPS_CERT_PATH'. | ||
300 | |||
301 | @item MHD_OPTION_HTTPS_CERT_PATH | ||
302 | Filename for the certificate (cert.pem) to be used by the | ||
303 | HTTPS daemon. This option should be followed by an | ||
304 | "const char*" argument. The memory of the filename must | ||
305 | not be released until the application terminates. | ||
306 | This should be used in conjunction with 'MHD_OPTION_HTTPS_KEY_PATH'. | ||
307 | |||
308 | @item MHD_OPTION_HTTPS_MEM_KEY | 295 | @item MHD_OPTION_HTTPS_MEM_KEY |
309 | Memory pointer to the private key to be used by the | 296 | Memory pointer to the private key to be used by the |
310 | HTTPS daemon. This option should be followed by an | 297 | HTTPS daemon. This option should be followed by an |
@@ -416,6 +403,31 @@ We had to close the session since @mhd{} was being shut down. | |||
416 | List of symmetric ciphers. | 403 | List of symmetric ciphers. |
417 | Note that not all listed algorithms are necessarily supported by | 404 | Note that not all listed algorithms are necessarily supported by |
418 | all builds of MHD. | 405 | all builds of MHD. |
406 | |||
407 | @table @code | ||
408 | @item MHD_GNUTLS_CIPHER_UNKNOWN | ||
409 | |||
410 | @item MHD_GNUTLS_CIPHER_NULL | ||
411 | |||
412 | @item MHD_GNUTLS_CIPHER_ARCFOUR_128 | ||
413 | |||
414 | @item MHD_GNUTLS_CIPHER_3DES_CBC | ||
415 | |||
416 | @item MHD_GNUTLS_CIPHER_AES_128_CBC | ||
417 | |||
418 | @item MHD_GNUTLS_CIPHER_AES_256_CBC | ||
419 | |||
420 | @item MHD_GNUTLS_CIPHER_ARCFOUR_40 | ||
421 | |||
422 | @item MHD_GNUTLS_CIPHER_CAMELLIA_128_CBC | ||
423 | |||
424 | @item MHD_GNUTLS_CIPHER_CAMELLIA_256_CBC | ||
425 | |||
426 | @item MHD_GNUTLS_CIPHER_RC2_40_CBC | ||
427 | |||
428 | @item MHD_GNUTLS_CIPHER_DES_CBC | ||
429 | |||
430 | @end table | ||
419 | @end deftp | 431 | @end deftp |
420 | 432 | ||
421 | 433 | ||
@@ -423,6 +435,170 @@ all builds of MHD. | |||
423 | List of key exchange algorithms. | 435 | List of key exchange algorithms. |
424 | Note that not all listed algorithms are necessarily supported by | 436 | Note that not all listed algorithms are necessarily supported by |
425 | all builds of MHD. | 437 | all builds of MHD. |
438 | |||
439 | @table @code | ||
440 | |||
441 | @item MHD_GNUTLS_KX_UNKNOWN | ||
442 | |||
443 | @item MHD_GNUTLS_KX_RSA | ||
444 | |||
445 | @item MHD_GNUTLS_KX_DHE_DSS | ||
446 | |||
447 | @item MHD_GNUTLS_KX_DHE_RSA | ||
448 | |||
449 | @item MHD_GNUTLS_KX_ANON_DH | ||
450 | |||
451 | @item MHD_GNUTLS_KX_SRP | ||
452 | |||
453 | @item MHD_GNUTLS_KX_RSA_EXPORT | ||
454 | |||
455 | @item MHD_GNUTLS_KX_SRP_RSA | ||
456 | |||
457 | @item MHD_GNUTLS_KX_SRP_DSS | ||
458 | @end table | ||
459 | @end deftp | ||
460 | |||
461 | |||
462 | @deftp {Enumeration} MHD_GNUTLS_CredentialsType | ||
463 | Server credentials type (note that not all types | ||
464 | maybe supported by all MHD builds). | ||
465 | |||
466 | @table @code | ||
467 | @item MHD_GNUTLS_CRD_CERTIFICATE | ||
468 | We have a x.509 certificate. | ||
469 | |||
470 | @item MHD_GNUTLS_CRD_ANON | ||
471 | We have no certificate (anonymous). | ||
472 | |||
473 | @item MHD_GNUTLS_CRD_SRP | ||
474 | We are using password-based authentication. | ||
475 | |||
476 | @item MHD_GNUTLS_CRD_PSK | ||
477 | We are using pre-shared keys (PSK). | ||
478 | |||
479 | @end table | ||
480 | @end deftp | ||
481 | |||
482 | |||
483 | @deftp {Enumeration} MHD_GNUTLS_HashAlgorithm | ||
484 | Enumeration of possible cryptographic hash functions (for MAC and | ||
485 | Digest operations). Note that not all listed algorithms are | ||
486 | necessarily supported by all builds of MHD. | ||
487 | |||
488 | @table @code | ||
489 | @item MHD_GNUTLS_MAC_UNKNOWN | ||
490 | |||
491 | @item MHD_GNUTLS_MAC_NULL | ||
492 | |||
493 | @item MHD_GNUTLS_MAC_MD5 | ||
494 | |||
495 | @item MHD_GNUTLS_MAC_SHA1 | ||
496 | |||
497 | @item MHD_GNUTLS_MAC_SHA256 | ||
498 | |||
499 | @end table | ||
500 | @end deftp | ||
501 | |||
502 | |||
503 | @deftp {Enumeration} MHD_GNUTLS_CompressionMethod | ||
504 | List of compression methods. Note that not all listed algorithms are | ||
505 | necessarily supported by all builds of MHD. | ||
506 | |||
507 | @table @code | ||
508 | @item MHD_GNUTLS_COMP_UNKNOWN | ||
509 | |||
510 | @item MHD_GNUTLS_COMP_NULL | ||
511 | No compression. | ||
512 | |||
513 | @item MHD_GNUTLS_COMP_DEFLATE | ||
514 | gzip compression. | ||
515 | |||
516 | @end table | ||
517 | @end deftp | ||
518 | |||
519 | |||
520 | |||
521 | @deftp {Enumeration} MHD_GNUTLS_Protocol | ||
522 | SSL/TLS Protocol types. Note that not all listed algorithms are | ||
523 | necessarily supported by all builds of MHD. | ||
524 | |||
525 | @table @code | ||
526 | @item MHD_GNUTLS_PROTOCOL_END | ||
527 | @item MHD_GNUTLS_PROTOCOL_SSL3 | ||
528 | @item MHD_GNUTLS_PROTOCOL_TLS1_0 | ||
529 | @item MHD_GNUTLS_PROTOCOL_TLS1_1 | ||
530 | @item MHD_GNUTLS_PROTOCOL_TLS1_2 | ||
531 | @item MHD_GNUTLS_PROTOCOL_UNKNOWN | ||
532 | |||
533 | @end table | ||
534 | @end deftp | ||
535 | |||
536 | |||
537 | |||
538 | @deftp {Enumeration} MHD_GNUTLS_PublicKeyAlgorithm | ||
539 | List of public key algorithms. Note that not all listed algorithms | ||
540 | are necessarily supported by all builds of MHD. | ||
541 | |||
542 | @table @code | ||
543 | @item MHD_GNUTLS_PK_UNKNOWN | ||
544 | |||
545 | @item MHD_GNUTLS_PK_RSA | ||
546 | |||
547 | @end table | ||
548 | @end deftp | ||
549 | |||
550 | |||
551 | @deftp {Enumeration} MHD_ConnectionInfoType | ||
552 | Values of this enum are used to specify what information about a | ||
553 | connection is desired. | ||
554 | |||
555 | @table @code | ||
556 | |||
557 | @item MHD_CONNECTION_INFO_CIPHER_ALGO | ||
558 | What cipher algorithm is being used. | ||
559 | Takes no extra arguments. | ||
560 | |||
561 | @item MHD_CONNECTION_INFO_KX_ALGO | ||
562 | What key exchange algorithm is being used. | ||
563 | Takes no extra arguments. | ||
564 | |||
565 | @item MHD_CONNECTION_INFO_CREDENTIALS_TYPE | ||
566 | Takes no extra arguments. | ||
567 | |||
568 | @item MHD_CONNECTION_INFO_MAC_ALGO | ||
569 | Takes no extra arguments. | ||
570 | |||
571 | @item MHD_CONNECTION_INFO_COMPRESSION_METHOD, | ||
572 | What compression method is being used. | ||
573 | Takes no extra arguments. | ||
574 | |||
575 | @item MHD_CONNECTION_INFO_PROTOCOL, | ||
576 | Takes no extra arguments. | ||
577 | |||
578 | @item MHD_CONNECTION_INFO_CERT_TYPE | ||
579 | Takes no extra arguments. | ||
580 | |||
581 | @end table | ||
582 | @end deftp | ||
583 | |||
584 | |||
585 | |||
586 | |||
587 | @deftp {Enumeration} MHD_DaemonInfoType | ||
588 | Values of this enum are used to specify what | ||
589 | information about a deamon is desired. | ||
590 | @table @code | ||
591 | @item MHD_DAEMON_INFO_KEY_SIZE | ||
592 | Request information about the key size for a particular cipher | ||
593 | algorithm. The cipher algorithm should be passed as an extra argument | ||
594 | (of type 'enum MHD_GNUTLS_CipherAlgorithm'). | ||
595 | |||
596 | @item MHD_DAEMON_INFO_MAC_KEY_SIZE | ||
597 | Request information about the key size for a particular cipher | ||
598 | algorithm. The cipher algorithm should be passed as an extra argument | ||
599 | (of type 'enum MHD_GNUTLS_HashAlgorithm'). | ||
600 | |||
601 | @end table | ||
426 | @end deftp | 602 | @end deftp |
427 | 603 | ||
428 | 604 | ||
@@ -455,6 +631,16 @@ Handle for @code{POST} processing. | |||
455 | @end deftp | 631 | @end deftp |
456 | 632 | ||
457 | 633 | ||
634 | @deftp {C Union} MHD_ConnectionInfo | ||
635 | Information about a connection. | ||
636 | @end deftp | ||
637 | |||
638 | |||
639 | @deftp {C Union} MHD_DaemonInfo | ||
640 | Information about an MHD daemon. | ||
641 | @end deftp | ||
642 | |||
643 | |||
458 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | 644 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
459 | 645 | ||
460 | @c ------------------------------------------------------------ | 646 | @c ------------------------------------------------------------ |
@@ -1223,6 +1409,72 @@ of this function. | |||
1223 | @end deftypefun | 1409 | @end deftypefun |
1224 | 1410 | ||
1225 | 1411 | ||
1412 | |||
1413 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
1414 | |||
1415 | @c ------------------------------------------------------------ | ||
1416 | @node microhttpd-info | ||
1417 | @chapter Obtaining status information. | ||
1418 | |||
1419 | |||
1420 | @menu | ||
1421 | * microhttpd-info daemon:: State information about an MHD daemon | ||
1422 | * microhttpd-info conn:: State information about a connection | ||
1423 | @end menu | ||
1424 | |||
1425 | |||
1426 | @c ------------------------------------------------------------ | ||
1427 | @node microhttpd-info daemon | ||
1428 | @section Obtaining state information about an MHD daemon | ||
1429 | |||
1430 | @deftypefun {const union MHD_DaemonInfo *} MHD_get_daemon_info (struct MHD_Daemon *daemon, enum MHD_DaemonInfoType infoType, ...) | ||
1431 | Obtain information about the given daemon. This function | ||
1432 | is currently not fully implemented. | ||
1433 | |||
1434 | @table @var | ||
1435 | @item daemon | ||
1436 | the daemon about which information is desired; | ||
1437 | |||
1438 | @item infoType | ||
1439 | type of information that is desired | ||
1440 | |||
1441 | @item ... | ||
1442 | additional arguments about the desired information (depending on | ||
1443 | infoType) | ||
1444 | @end table | ||
1445 | |||
1446 | Returns a union with the respective member (depending on | ||
1447 | infoType) set to the desired information), or NULL | ||
1448 | in case the desired information is not available or | ||
1449 | applicable. | ||
1450 | @end deftypefun | ||
1451 | |||
1452 | @c ------------------------------------------------------------ | ||
1453 | @node microhttpd-info conn | ||
1454 | @section Obtaining state information about a connection | ||
1455 | |||
1456 | |||
1457 | @deftypefun {const union MHD_ConnectionInfo *} MHD_get_connection_info (struct MHD_Connection *daemon, enum MHD_ConnectionInfoType infoType, ...) | ||
1458 | Obtain information about the given connection. | ||
1459 | |||
1460 | @table @var | ||
1461 | @item connection | ||
1462 | the connection about which information is desired; | ||
1463 | |||
1464 | @item infoType | ||
1465 | type of information that is desired | ||
1466 | |||
1467 | @item ... | ||
1468 | additional arguments about the desired information (depending on | ||
1469 | infoType) | ||
1470 | @end table | ||
1471 | |||
1472 | Returns a union with the respective member (depending on | ||
1473 | infoType) set to the desired information), or NULL | ||
1474 | in case the desired information is not available or | ||
1475 | applicable. | ||
1476 | @end deftypefun | ||
1477 | |||
1226 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | 1478 | @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1227 | 1479 | ||
1228 | 1480 | ||