[apple/security.git] / SecurityTests / clxutils / ocspTool / ocspRequest.h

/*
 * Copyright (c) 2004-2005 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@
 */

/*
 * ocspRequest.h - OCSP Request class
 */
 
#ifndef	_OCSP_REQUEST_H_
#define _OCSP_REQUEST_H_

#include <Security/SecAsn1Coder.h>
#include <Security/ocspTemplates.h>
#include <security_utilities/utilities.h>
#include <clAppUtils/CertParser.h>

class OCSPClientCertID;

class OCSPRequest
{
	NOCOPY(OCSPRequest)
public:
	/*
	 * The only constructor. Subject and issuer must remain valid for the 
	 * lifetime of this object. 
	 */
	OCSPRequest(
		CertParser		&subject,
		CertParser		&issuer,
		bool			genNonce);
		
	~OCSPRequest();
	
	/* 
	 * Obtain encoded OCSP request suitable for posting to responder.
	 * This object owns and maintains the memory.
	 */
	const CSSM_DATA *encode();

	/* 
	 * Obtain this request's nonce (which we randomly generate at encode() time),
	 * This object owns and maintains the memory. Result is NULL} if we
	 * didn't generate a nonce. 
	 */
	const CSSM_DATA *nonce();
			
	/* 
	 * Obtain this request's CertID. Used to look up matching SingleResponse
	 * in the OCSPResponse.
	 */
	OCSPClientCertID	*certID();
	
private:
	SecAsn1CoderRef		mCoder;
	CertParser			&mSubject;
	CertParser			&mIssuer;
	bool				mGenNonce;
	CSSM_DATA			mNonce;
	CSSM_DATA			mEncoded;	/* lazily evaluated */
	OCSPClientCertID	*mCertID;	/* calculated during encode() */
	
};

#endif	/* _OCSP_REQUEST_H_ */
Commit	Line	Data
b1ab9ed8	1	/*
d8f41ccd	2	* Copyright (c) 2004-2005 Apple Computer, Inc. All Rights Reserved.
b1ab9ed8 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23
	24	/*
	25	* ocspRequest.h - OCSP Request class
	26	*/
	27
	28	#ifndef _OCSP_REQUEST_H_
	29	#define _OCSP_REQUEST_H_
	30
b1ab9ed8 A	31	#include <Security/SecAsn1Coder.h>
b1ab9ed8 A	32	#include <Security/ocspTemplates.h>
d8f41ccd A	33	#include <security_utilities/utilities.h>
d8f41ccd A	34	#include <clAppUtils/CertParser.h>
b1ab9ed8 A	35
	36	class OCSPClientCertID;
	37
	38	class OCSPRequest
	39	{
	40	NOCOPY(OCSPRequest)
	41	public:
	42	/*
	43	* The only constructor. Subject and issuer must remain valid for the
d8f41ccd	44	* lifetime of this object.
b1ab9ed8 A	45	*/
b1ab9ed8 A	46	OCSPRequest(
d8f41ccd A	47	CertParser &subject,
d8f41ccd A	48	CertParser &issuer,
b1ab9ed8 A	49	bool genNonce);
	50
	51	~OCSPRequest();
	52
	53	/*
	54	* Obtain encoded OCSP request suitable for posting to responder.
	55	* This object owns and maintains the memory.
	56	*/
	57	const CSSM_DATA *encode();
	58
	59	/*
	60	* Obtain this request's nonce (which we randomly generate at encode() time),
	61	* This object owns and maintains the memory. Result is NULL} if we
	62	* didn't generate a nonce.
	63	*/
	64	const CSSM_DATA *nonce();
	65
	66	/*
	67	* Obtain this request's CertID. Used to look up matching SingleResponse
	68	* in the OCSPResponse.
	69	*/
	70	OCSPClientCertID *certID();
	71
	72	private:
	73	SecAsn1CoderRef mCoder;
d8f41ccd A	74	CertParser &mSubject;
d8f41ccd A	75	CertParser &mIssuer;
b1ab9ed8 A	76	bool mGenNonce;
	77	CSSM_DATA mNonce;
	78	CSSM_DATA mEncoded; /* lazily evaluated */
	79	OCSPClientCertID mCertID; / calculated during encode() */
	80
	81	};
	82
	83	#endif /* _OCSP_REQUEST_H_ */
	84