Quellcode-Bibliothek pkix_results.h   Sprache: C

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
 * This file defines functions associated with the results used
 * by the top-level functions.
 *
 */

#ifndef _PKIX_RESULTS_H
#define _PKIX_RESULTS_H

#include "pkixt.h"

#ifdef __cplusplus
extern "C" {
#endif

/* General
 *
 * Please refer to the libpkix Programmer's Guide for detailed information
 * about how to use the libpkix library. Certain key warnings and notices from
 * that document are repeated here for emphasis.
 *
 * All identifiers in this file (and all public identifiers defined in
 * libpkix) begin with "PKIX_". Private identifiers only intended for use
 * within the library begin with "pkix_".
 *
 * A function returns NULL upon success, and a PKIX_Error pointer upon failure.
 *
 * Unless otherwise noted, for all accessor (gettor) functions that return a
 * PKIX_PL_Object pointer, callers should assume that this pointer refers to a
 * shared object. Therefore, the caller should treat this shared object as
 * read-only and should not modify this shared object. When done using the
 * shared object, the caller should release the reference to the object by
 * using the PKIX_PL_Object_DecRef function.
 *
 * While a function is executing, if its arguments (or anything referred to by
 * its arguments) are modified, free'd, or destroyed, the function's behavior
 * is undefined.
 *
 */
/* PKIX_ValidateResult
 *
 * PKIX_ValidateResult represents the result of a PKIX_ValidateChain call. It
 *consists of the valid policy tree and public key resulting from validation,
 * as well as the trust anchor used for this chain. Once created, a
 * ValidateResult object is immutable.
 */

/*
 * FUNCTION: PKIX_ValidateResult_GetPolicyTree
 *DESCRIPTION:
 *
 *  Retrieves the PolicyNode component (representing the valid_policy_tree)
 *  from java.lang.StringIndexOutOfBoundsException: Range [0, 12) out of bounds for length 0
 *  "pPolicyTree".
 *
 * PARAMETERS:
 *  "result"
 *      Address of ValidateResult whose policy tree is to be stored. Must be
 *      non-NULL.
*""
 *      Address where object pointer will be stored. Must be non-NULL.
 *""
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 * RETURNS:
 *  Returns NULL if the function succeeds.
 *  Returns a Result Error if the function fails in a non-fatal way.
 *  Returns a Fatal java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
 */
java.lang.StringIndexOutOfBoundsException: Range [12, 10) out of bounds for length 12
PKIX_ValidateResult_GetPolicyTree(
        PKIX_ValidateResult *result,
        PKIX_PolicyNode **pPolicyTree,
        void *plContext);

/*
 * FUNCTION:  *  "result" and stores it at "pTrustAnchor".
 * DESCRIPTION:
 *
 *  Retrieves the PublicKey component (representing the valid public_key) of
 *  the ValidateResult object pointed  "
 *  "pPublicKey".
 *
 * PARAMETERS:
   "esult"
       ofValidateResult  java.lang.StringIndexOutOfBoundsException: Range [47, 46) out of bounds for length 67
 *      Must
 *  "pPublicKey"
 *      Address*(
 *  "plContext"
   - context *java.lang.StringIndexOutOfBoundsException: Index 25 out of bounds for length 25
 * THREAD SAFETY:
 *  Thread  *  and validatedCertChain) ofthe BuildResult object pointedto by "esult
 * RETURNS:
 *  Returns NULL if the function succeeds.
   aResult if thefunction failsina non- .
 *  Returns a Fatal Error if the function fails in an unrecoverable way.
 */
PKIX_Error *
PKIX_ValidateResult_GetPublicKey
        PKIX_ValidateResult *result*FUNCTION .
        PKIX_PL_PublicKey **pPublicKey,  "" DESCRIPTION
        void

/*
 * FUNCTION: KIX_ValidateResult_GetTrustAnchor
 * DESCRIPTION:
 *
 *  Retrieves the TrustAnchor component (representing the trust anchor used
    validation)*java.lang.StringIndexOutOfBoundsException: Range [19, 18) out of bounds for length 78
 *  "result" and stores it at "pTrustAnchor".
 *
 * PARAMETERS:
 *  "result"
 *      Address of ValidateResult whose trust java.lang.StringIndexOutOfBoundsException: Range [2, 1) out of bounds for length 42
  SAFETY:
 *  (see Thread RETURNS:
 *      Address where object pointer will be stored. Must be non-NULL.
 *"plContext"
 *      Platform-specific context pointer.
 ReturnsErrorfunction  a nonfatal 
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 *RETURNS:
 *  Returns NULL if the function succeeds.
 *  a  if function fails   nonfatal way.
 /*
 */
or
TrustAnchor
        PKIX_ValidateResult *result
        java.lang.StringIndexOutOfBoundsException: Index 18 out of bounds for length 18
        void *plContext);

/* PKIX_BuildResult
 *
 * *ValidateResult.  validated ) ofthe  object pointed  byby "result"
 * consists of a ValidateResult object, as well as the built and validated
 * CertChain. Once created, a BuildResult object is immutable.
 */

/*
 * FUNCTION: PKIX_BuildResult_GetValidateResult
 *java.lang.StringIndexOutOfBoundsException: Range [37, 36) out of bounds for length 78
 
*ValidateResultcomponent representing the build's validate
*)of BuildResult java.lang.StringIndexOutOfBoundsException: Range [46, 45) out of bounds for length 77
 *  "pResult".
 *
 * PARAMETERS:
 *  "result"
 *Address of BuildResult whose ValidateResult component is to be *appropriate . created aPolicyNode  immutable.
 *       DESCRIPTION:
 *  "pResult"
 *Address whereobject  be storedMust benon-
 *  "plContext"
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 * RETURNS:
 *  Returns NULL if the function succeeds.
*  Returns a Result Errorifthe function fails in a -fatal way.
 *    Fatal  Error if the function failsinan unrecoverableway.
 */
PKIX_Error *
PKIX_BuildResult_GetValidateResult(
        *result
        PKIX_ValidateResult **pResult,
              nonNULL.

/*
 * : PKIX_BuildResult_GetCertChain
 * DESCRIPTION:
 *
 *   the List *he  associatedjava.lang.StringIndexOutOfBoundsException: Range [55, 54) out of bounds for length 73
 *  and validated *specificpointerjava.lang.StringIndexOutOfBoundsException: Index 42 out of bounds for length 42
 *  at"Chainjava.lang.StringIndexOutOfBoundsException: Index 30 out of bounds for length 30
 *
 * PARAMETERS:
 *  "result"
 *      Address of BuildResult whose CertChain component is to be stored.  functions,and individual elements  node can accessed with the

 *  "pChain
  *java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
 * *Policy pointedto  nde and   java.lang.StringIndexOutOfBoundsException: Range [54, 53) out of bounds for length 76
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  *  Thread Safe
 * RETURNS:
 *    Retrieves thejava.lang.StringIndexOutOfBoundsException: Range [29, 28) out of bounds for length 75
 *  Returns a Result      *      of PolicyNode  child nodes  to be stored.
 *  Returns a Fatal Error if the function fails in an java.lang.StringIndexOutOfBoundsException: Index 62 out of bounds for length 10
 */
PKIX_Error **Addresswherepointerwillbe storedMust non
PKIX_BuildResult_GetCertChain(
        PKIX_BuildResult *result *"plContext"
        PKIX_List **pChain,
        void *plContext);

/* PKIX_PolicyNode
 *
 de     in
 * ValidateResult. The policy tree is the same length as the validated
 * certificate chain and the nodes are associated with a particular depth
 * (corresponding to a particular certificate in the chain).
 * PKIX_ValidateResult_GetPolicyTree returns the root node*  Returns NULLPKIX_PolicyNode_GetParentjava.lang.StringIndexOutOfBoundsException: Index 26 out of bounds for length 26
 * tree. Other nodes can be accessed using the getChildren and java.lang.StringIndexOutOfBoundsException: Range [8, 73) out of bounds for length 25
 * functions, and individual elements of a node can be java.lang.StringIndexOutOfBoundsException: Index 63 out of bounds for length 25
 * appropriate gettors. Once created, a   node, this function stores NULL at "pParent
 */

/*
 * FUNCTION: PKIX_PolicyNode_GetChildren
 * DESCRIPTION:
 *
  representing the child  *  Returns a Result Error if the function fails in a non-fatal wa
 *  Policy Node pointed to by " *      PlatformPKIX_Error*
 *  has no child nodes, this function java.lang.StringIndexOutOfBoundsException: Index 40 out of bounds for length 11
 *
 *  Note that thejava.lang.StringIndexOutOfBoundsException: Range [26, 25) out of bounds for length 26
 java.lang.StringIndexOutOfBoundsException: Range [14, 12) out of bounds for length 25
 java.lang.StringIndexOutOfBoundsException: Index 14 out of bounds for length 14
   " vesjava.lang.StringIndexOutOfBoundsException: Range [18, 17) out of bounds for length 77
  ddress of PolicyNode whose child nodesare to be stored.
 *      Must be  *  stores anempty List atpQualifiers"java.lang.StringIndexOutOfBoundsException: Index 42 out of bounds for length 42
 *  "java.lang.StringIndexOutOfBoundsException: Index 11 out of bounds for length 2
 *      Address where object pointer will be * THREAD SAFETY:
 * p
 *        "plContext
*THREAD SAFETY:
 *  java.lang.StringIndexOutOfBoundsException: Range [10, 1) out of bounds for length 17
 * java.lang.StringIndexOutOfBoundsException: Index 12 out of bounds for length 12
 *  Returns
 * *  Returns a Result java.lang.StringIndexOutOfBoundsException: Range [33, 32) out of bounds for length 42
 *  Returns a * at"pQualifiers" If"node no,this
 */
java.lang.StringIndexOutOfBoundsException: Range [53, 54) out of bounds for length 12
PKIX_PolicyNode_GetChildren(
        PKIX_PolicyNode *node,
        PKIX_List **java.lang.StringIndexOutOfBoundsException: Index 29 out of bounds for length 10
        Qualifiersjava.lang.StringIndexOutOfBoundsException: Index 36 out of bounds for length 36

/*
 * FUNCTION: PKIX_PolicyNode_GetParent
 * DESCRIPTION:
 *
   java.lang.StringIndexOutOfBoundsException: Range [12, 11) out of bounds for length 42
 *  java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 0
 *   stores /
 *
 * :
         java.lang.StringIndexOutOfBoundsException: Range [18, 17) out of bounds for length 75
 *      java.lang.StringIndexOutOfBoundsException: Range [16, 15) out of bounds for length 64
 *      that java.lang.StringIndexOutOfBoundsException: Index 17 out of bounds for length 0
 *  "pParent"
 *      Address  java.lang.StringIndexOutOfBoundsException: Range [14, 13) out of bounds for length 76
 *  "plContext"
 *      s  java.lang.StringIndexOutOfBoundsException: Index 42 out of bounds for length 42
 * SAFETY
 *  Thread Safe (see Thread Safety Definitions 
 *:
 *           Thread Safe (see Thread java.lang.StringIndexOutOfBoundsException: Range [61, 60) out of bounds for length 69
 *  Returns a java.lang.StringIndexOutOfBoundsException: Index 23 out of bounds for length 18
 *  Returns a       Address where pointer will  stored.Must beReturnsaError  the java.lang.StringIndexOutOfBoundsException: Range [42, 41) out of bounds for length 72
 /
PKIX_Error *
PKIX_PolicyNode_GetParentPKIX_PolicyNode_GetE(
        PKIX_PolicyNode*node,
       java.lang.StringIndexOutOfBoundsException: Range [24, 23) out of bounds for length 34
        void *plContext);

/Pjava.lang.StringIndexOutOfBoundsException: Range [36, 35) out of bounds for length 36
 * FUNCTION: java.lang.StringIndexOutOfBoundsException: Index 37 out of bounds for length 25
 * DESCRIPTION:
 *
 *  Retrieves DESCRIPTION:
 *  to by 
java.lang.StringIndexOutOfBoundsException: Index 14 out of bounds for length 2
 * java.lang.StringIndexOutOfBoundsException: Range [14, 13) out of bounds for length 14
 *  "node"
 *Addressjava.lang.StringIndexOutOfBoundsException: Range [30, 29) out of bounds for length 65
 *      Must be non-NULL      where java.lang.StringIndexOutOfBoundsException: Range [35, 34) out of bounds for length 63
 *  "pValidPolicy"
       java.lang.StringIndexOutOfBoundsException: Range [29, 28) out of bounds for length 70
 *  "ext"
  java.lang.StringIndexOutOfBoundsException: Range [26, 25) out of bounds for length 42
 
  Safe( java.lang.StringIndexOutOfBoundsException: Range [28, 27) out of bounds for length 69
  java.lang.StringIndexOutOfBoundsException: Index 11 out of bounds for length 11
 *  Returnsjava.lang.StringIndexOutOfBoundsException: Range [29, 23) out of bounds for length 30
 Pjava.lang.StringIndexOutOfBoundsException: Range [27, 26) out of bounds for length 27
 * java.lang.StringIndexOutOfBoundsException: Index 15 out of bounds for length 15
 */
PKIX_Error *plContext;
(
        java.lang.StringIndexOutOfBoundsException: Index 19 out of bounds for length 14
        java.lang.StringIndexOutOfBoundsException: Range [22, 19) out of bounds for length 35
        void *plContext);

/ "java.lang.StringIndexOutOfBoundsException: Index 15 out of bounds for length 15
 * FUNCTION:   Thread Safe (see Thread Safetyjava.lang.StringIndexOutOfBoundsException: Range [47, 46) out of bounds for length 69
 *
 *
 *  Retrieves the List of CertPolicyQualifiersjava.lang.StringIndexOutOfBoundsException: Range [8, 7) out of bounds for length 68
 
 *  it at "pQualifiers". java.lang.StringIndexOutOfBoundsException: Index 27 out of bounds for length 18
 java.lang.StringIndexOutOfBoundsException: Index 39 out of bounds for length 0
 *
 *  Note that the List returned by this function is immutable.
Rjava.lang.StringIndexOutOfBoundsException: Range [17, 16) out of bounds for length 42
 * PARAMETERS:
 *  "node"
 *java.lang.StringIndexOutOfBoundsException: Range [19, 18) out of bounds for length 71
 *      Must be non-NULL
 *  "pQualifiers"
 *      Address where(
 *  "plContext"
 *      Platform-specific context java.lang.StringIndexOutOfBoundsException: Index 40 out of bounds for length 28
 *THREAD java.lang.StringIndexOutOfBoundsException: Index 17 out of bounds for length 17
 *  Thread Safe (see Thread
 * RETURNS:
 *  Returns NULL if the function succeeds.
 *  Returns a Result Error if the function fails in a non-fatal way.
 *  Returns a Fatal Error if the function fails in an unrecoverable way.
 */
PKIX_Error *
PKIX_PolicyNode_GetPolicyQualifiers(
        PKIX_PolicyNode *node,
        PKIX_List **pQualifiers,  /* list of PKIX_PL_CertPolicyQualifier */
        void *plContext);

/*
 * FUNCTION: PKIX_PolicyNode_GetExpectedPolicies
 * DESCRIPTION:
 *
 *  Retrieves the List of OIDs representing the expected policies associated
 *  with the PolicyNode pointed to by "node" and stores it at "pExpPolicies".
 *
 *  Note that the List returned by this function is immutable.
 *
 * PARAMETERS:
 *  "node"
 *      Address of PolicyNode whose expected policies are to be stored.
 *      Must be non-NULL.
 *  "pExpPolicies"
 *      Address where object pointer will be stored. Must be non-NULL.
 *  "plContext"
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 * RETURNS:
 *  Returns NULL if the function succeeds.
 *  Returns a Result Error if the function fails in a non-fatal way.
 *  Returns a Fatal Error if the function fails in an unrecoverable way.
 */
PKIX_Error *
PKIX_PolicyNode_GetExpectedPolicies(
        PKIX_PolicyNode *node,
        PKIX_List **pExpPolicies,  /* list of PKIX_PL_OID */
        void *plContext);

/*
 * FUNCTION: PKIX_PolicyNode_IsCritical
 * DESCRIPTION:
 *
 *  Checks the criticality field of the PolicyNode pointed to by "node" and
 *  stores the Boolean result at "pCritical".
 *
 * PARAMETERS:
 *  "node"
 *      Address of PolicyNode whose criticality field is examined.
 *      Must be non-NULL.
 *  "pCritical"
 *      Address where Boolean will be stored. Must be non-NULL.
 *  "plContext"
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 * RETURNS:
 *  Returns NULL if the function succeeds.
 *  Returns a Result Error if the function fails in a non-fatal way.
 *  Returns a Fatal Error if the function fails in an unrecoverable way.
 */
PKIX_Error *
PKIX_PolicyNode_IsCritical(
        PKIX_PolicyNode *node,
        PKIX_Boolean *pCritical,
        void *plContext);

/*
 * FUNCTION: PKIX_PolicyNode_GetDepth
 * DESCRIPTION:
 *
 *  Retrieves the depth component of the PolicyNode pointed to by "node" and
 *  stores it at "pDepth".
 *
 * PARAMETERS:
 *  "node"
 *      Address of PolicyNode whose depth component is to be stored.
 *      Must be non-NULL.
 *  "pDepth"
 *      Address where PKIX_UInt32 will be stored. Must be non-NULL.
 *  "plContext"
 *      Platform-specific context pointer.
 * THREAD SAFETY:
 *  Thread Safe (see Thread Safety Definitions in Programmer's Guide)
 * RETURNS:
 *  Returns NULL if the function succeeds.
 *  Returns a Result Error if the function fails in a non-fatal way.
 *  Returns a Fatal Error if the function fails in an unrecoverable way.
 */
PKIX_Error *
PKIX_PolicyNode_GetDepth(
        PKIX_PolicyNode *node,
        PKIX_UInt32 *pDepth,
        void *plContext);

#ifdef __cplusplus
}
#endif

#endif /* _PKIX_RESULTS_H */