pkinit_client.h   [plain text]


/*
 * Copyright (c) 2004 Apple Computer, Inc. All Rights Reserved.
 * 
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/*
 * pkinit_client.h - Client side routines for PKINIT
 *
 * Created 20 May 2004 by Doug Mitchell at Apple.
 */

#ifndef _PKINIT_CLIENT_H_
#define _PKINIT_CLIENT_H_

#include "krb5.h"
#include "pkinit_cms.h"
#include "pkinit_cert_store.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Create a PA-PK-AS-REQ message.
 */
krb5_error_code pkinit_as_req_create(
    krb5_timestamp	    ctime,      
    krb5_ui_4		    cusec,	    // microseconds
    krb5_ui_4		    nonce,
    const krb5_checksum     *cksum,
    pkinit_signing_cert_t   client_cert,    // required
    const krb5_data	    *kdc_cert,      // optional
    krb5_data		    *as_req);	    // mallocd and RETURNED

/*
 * Parse PA-PK-AS-REP message. Optionally evaluates the message's certificate chain. 
 * Optionally returns various components. 
 */
krb5_error_code pkinit_as_rep_parse(
    const krb5_data	    *as_rep,
    pkinit_signing_cert_t   client_cert,    // required
    krb5_keyblock	    *key_block,     // RETURNED
    krb5_ui_4		    *nonce,	    // RETURNED
    pki_cert_sig_status     *cert_status,   // RETURNED
    
    /*
     * Describe the ContentInfos : signed and/or encrypted. 
     * Both should be true for a valid PA-PK-AS-REP. Both RETURNED. 
     */
    krb5_boolean	    *is_signed,
    krb5_boolean	    *is_encrypted,

    /*
     * Cert fields, all optionally RETURNED.
     *
     * signer_cert is the full X.509 leaf cert from the incoming SignedData.
     * all_certs is an array of all of the certs in the incoming SignedData,
     *    in full X.509 form. 
     */
    krb5_data		    *signer_cert,   // content mallocd
    unsigned		    *num_all_certs, // sizeof *all_certs
    krb5_data		    **all_certs);   // krb5_data's and their content mallocd

/*
 * Handy place to have a platform-dependent random number generator, e.g., /dev/random. 
 */
krb5_error_code pkinit_rand(
    void *dst,
    size_t len);
    
#ifdef __cplusplus
}
#endif

#endif  /* _PKINIT_CLIENT_H_ */