OLD | NEW |
1 /* This Source Code Form is subject to the terms of the Mozilla Public | 1 /* This Source Code Form is subject to the terms of the Mozilla Public |
2 * License, v. 2.0. If a copy of the MPL was not distributed with this | 2 * License, v. 2.0. If a copy of the MPL was not distributed with this |
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | 3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
4 /* | 4 /* |
5 * This file defines functions associated with the various parameters used | 5 * This file defines functions associated with the various parameters used |
6 * by the top-level functions. | 6 * by the top-level functions. |
7 * | 7 * |
8 */ | 8 */ |
9 | 9 |
10 #ifndef _PKIX_PARAMS_H | 10 #ifndef _PKIX_PARAMS_H |
(...skipping 618 matching lines...) Loading... |
629 */ | 629 */ |
630 PKIX_Error * | 630 PKIX_Error * |
631 PKIX_ProcessingParams_GetTrustAnchors( | 631 PKIX_ProcessingParams_GetTrustAnchors( |
632 PKIX_ProcessingParams *params, | 632 PKIX_ProcessingParams *params, |
633 PKIX_List **pAnchors, /* list of TrustAnchor */ | 633 PKIX_List **pAnchors, /* list of TrustAnchor */ |
634 void *plContext); | 634 void *plContext); |
635 /* | 635 /* |
636 * FUNCTION: PKIX_ProcessingParams_SetTrustAnchors | 636 * FUNCTION: PKIX_ProcessingParams_SetTrustAnchors |
637 * DESCRIPTION: | 637 * DESCRIPTION: |
638 * | 638 * |
639 * Sets user defined set of trust anchors. A certificate will be considered | 639 * Sets user defined set of trust anchors. The handling of the trust anchors |
640 * invalid if it does not chain to a trusted anchor from this list. | 640 * may be furthered alter via PKIX_ProcessingParams_SetUseOnlyTrustAnchors. |
641 * | 641 * By default, a certificate will be considered invalid if it does not chain |
| 642 * to a trusted anchor from this list. |
| 643 * |
642 * PARAMETERS: | 644 * PARAMETERS: |
643 * "params" | 645 * "params" |
644 * Address of ProcessingParams whose List of TrustAnchors are to | 646 * Address of ProcessingParams whose List of TrustAnchors are to |
645 * be stored. Must be non-NULL. | 647 * be stored. Must be non-NULL. |
646 * "anchors" | 648 * "anchors" |
647 * Address of the trust anchors list object. Must be non-NULL. | 649 * Address of the trust anchors list object. Must be non-NULL. |
648 * "plContext" | 650 * "plContext" |
649 * Platform-specific context pointer. | 651 * Platform-specific context pointer. |
650 * THREAD SAFETY: | 652 * THREAD SAFETY: |
651 * Conditionally Thread Safe | 653 * Conditionally Thread Safe |
652 * (see Thread Safety Definitions in Programmer's Guide) | 654 * (see Thread Safety Definitions in Programmer's Guide) |
653 * RETURNS: | 655 * RETURNS: |
654 * Returns NULL if the function succeeds. | 656 * Returns NULL if the function succeeds. |
655 * Returns a Params Error if the function fails in a non-fatal way. | 657 * Returns a Params Error if the function fails in a non-fatal way. |
656 * Returns a Fatal Error if the function fails in an unrecoverable way. | 658 * Returns a Fatal Error if the function fails in an unrecoverable way. |
657 */ | 659 */ |
658 PKIX_Error * | 660 PKIX_Error * |
659 PKIX_ProcessingParams_SetTrustAnchors( | 661 PKIX_ProcessingParams_SetTrustAnchors( |
660 PKIX_ProcessingParams *params, | 662 PKIX_ProcessingParams *params, |
661 PKIX_List *pAnchors, /* list of TrustAnchor */ | 663 PKIX_List *pAnchors, /* list of TrustAnchor */ |
662 void *plContext); | 664 void *plContext); |
663 | 665 |
664 /* | 666 /* |
| 667 * FUNCTION: PKIX_ProcessingParams_GetUseOnlyTrustAnchors |
| 668 * DESCRIPTION: |
| 669 * |
| 670 * Retrieves a pointer to the Boolean. The boolean value represents |
| 671 * the switch value that is used to identify whether trust anchors, if |
| 672 * specified, should be the exclusive source of trust information. |
| 673 * If the function succeeds, the pointer to the Boolean is guaranteed to be |
| 674 * non-NULL. |
| 675 * |
| 676 * PARAMETERS: |
| 677 * "params" |
| 678 * Address of ProcessingParams. Must be non-NULL. |
| 679 * "pUseOnlyTrustAnchors" |
| 680 * Address where object pointer will be stored. Must be non-NULL. |
| 681 * "plContext" |
| 682 * Platform-specific context pointer. |
| 683 * THREAD SAFETY: |
| 684 * Conditionally Thread Safe |
| 685 * (see Thread Safety Definitions in Programmer's Guide) |
| 686 * RETURNS: |
| 687 * Returns NULL if the function succeeds. |
| 688 * Returns a Params Error if the function fails in a non-fatal way. |
| 689 * Returns a Fatal Error if the function fails in an unrecoverable way. |
| 690 */ |
| 691 PKIX_Error * |
| 692 PKIX_ProcessingParams_GetUseOnlyTrustAnchors( |
| 693 PKIX_ProcessingParams *params, |
| 694 PKIX_Boolean *pUseOnlyTrustAnchors, |
| 695 void *plContext); |
| 696 |
| 697 /* |
| 698 * FUNCTION: PKIX_ProcessingParams_SetUseOnlyTrustAnchors |
| 699 * DESCRIPTION: |
| 700 * |
| 701 * Configures whether trust anchors are used as the exclusive source of trust. |
| 702 * |
| 703 * PARAMETERS: |
| 704 * "params" |
| 705 * Address of ProcessingParams. Must be non-NULL. |
| 706 * "useOnlyTrustAnchors" |
| 707 * If true, indicates that trust anchors should be used exclusively when |
| 708 * they have been specified via PKIX_ProcessingParams_SetTrustAnchors. A |
| 709 * certificate will be considered invalid if it does not chain to a |
| 710 * trusted anchor from that list. |
| 711 * If false, indicates that the trust anchors are additive to whatever |
| 712 * existing trust stores are configured. A certificate is considered |
| 713 * valid if it chains to EITHER a trusted anchor from that list OR a |
| 714 * certificate marked trusted in a trust store. |
| 715 * "plContext" |
| 716 * Platform-specific context pointer. |
| 717 * THREAD SAFETY: |
| 718 * Conditionally Thread Safe |
| 719 * (see Thread Safety Definitions in Programmer's Guide) |
| 720 * RETURNS: |
| 721 * Returns NULL if the function succeeds. |
| 722 * Returns a Params Error if the function fails in a non-fatal way. |
| 723 * Returns a Fatal Error if the function fails in an unrecoverable way. |
| 724 */ |
| 725 PKIX_Error * |
| 726 PKIX_ProcessingParams_SetUseOnlyTrustAnchors( |
| 727 PKIX_ProcessingParams *params, |
| 728 PKIX_Boolean useOnlyTrustAnchors, |
| 729 void *plContext); |
| 730 |
| 731 /* |
665 * FUNCTION: PKIX_ProcessingParams_GetUseAIAForCertFetching | 732 * FUNCTION: PKIX_ProcessingParams_GetUseAIAForCertFetching |
666 * DESCRIPTION: | 733 * DESCRIPTION: |
667 * | 734 * |
668 * Retrieves a pointer to the Boolean. The boolean value represents | 735 * Retrieves a pointer to the Boolean. The boolean value represents |
669 * the switch value that is used to identify if url in cert AIA extension | 736 * the switch value that is used to identify if url in cert AIA extension |
670 * may be used for cert fetching. | 737 * may be used for cert fetching. |
671 * If the function succeeds, the pointer to the Boolean is guaranteed to be | 738 * If the function succeeds, the pointer to the Boolean is guaranteed to be |
672 * non-NULL. | 739 * non-NULL. |
673 * | 740 * |
674 * PARAMETERS: | 741 * PARAMETERS: |
(...skipping 1042 matching lines...) Loading... |
1717 PKIX_ResourceLimits_SetMaxNumberOfCRLs( | 1784 PKIX_ResourceLimits_SetMaxNumberOfCRLs( |
1718 PKIX_ResourceLimits *resourceLimits, | 1785 PKIX_ResourceLimits *resourceLimits, |
1719 PKIX_UInt32 maxNumber, | 1786 PKIX_UInt32 maxNumber, |
1720 void *plContext); | 1787 void *plContext); |
1721 | 1788 |
1722 #ifdef __cplusplus | 1789 #ifdef __cplusplus |
1723 } | 1790 } |
1724 #endif | 1791 #endif |
1725 | 1792 |
1726 #endif /* _PKIX_PARAMS_H */ | 1793 #endif /* _PKIX_PARAMS_H */ |
OLD | NEW |