Blame nss/lib/smime/cmsmessage.c

Packit 40b132
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit 40b132
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit 40b132
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * CMS message methods.
Packit 40b132
 */
Packit 40b132
Packit 40b132
#include "cmslocal.h"
Packit 40b132
Packit 40b132
#include "cert.h"
Packit 40b132
#include "secasn1.h"
Packit 40b132
#include "secitem.h"
Packit 40b132
#include "secoid.h"
Packit 40b132
#include "pk11func.h"
Packit 40b132
#include "secerr.h"
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_Create - create a CMS message object
Packit 40b132
 *
Packit 40b132
 * "poolp" - arena to allocate memory from, or NULL if new arena should be created
Packit 40b132
 */
Packit 40b132
NSSCMSMessage *
Packit 40b132
NSS_CMSMessage_Create(PLArenaPool *poolp)
Packit 40b132
{
Packit 40b132
    void *mark = NULL;
Packit 40b132
    NSSCMSMessage *cmsg;
Packit 40b132
    PRBool poolp_is_ours = PR_FALSE;
Packit 40b132
Packit 40b132
    if (poolp == NULL) {
Packit 40b132
        poolp = PORT_NewArena (1024);           /* XXX what is right value? */
Packit 40b132
        if (poolp == NULL)
Packit 40b132
            return NULL;
Packit 40b132
        poolp_is_ours = PR_TRUE;
Packit 40b132
    }
Packit 40b132
Packit 40b132
    if (!poolp_is_ours)
Packit 40b132
        mark = PORT_ArenaMark(poolp);
Packit 40b132
Packit 40b132
    cmsg = (NSSCMSMessage *)PORT_ArenaZAlloc(poolp, sizeof(NSSCMSMessage));
Packit 40b132
    if (cmsg == NULL ||
Packit 40b132
        NSS_CMSContentInfo_Private_Init(&(cmsg->contentInfo)) != SECSuccess) {
Packit 40b132
        if (!poolp_is_ours) {
Packit 40b132
            if (mark) {
Packit 40b132
                PORT_ArenaRelease(poolp, mark);
Packit 40b132
            }
Packit 40b132
        } else
Packit 40b132
            PORT_FreeArena(poolp, PR_FALSE);
Packit 40b132
        return NULL;
Packit 40b132
    }
Packit 40b132
Packit 40b132
    cmsg->poolp = poolp;
Packit 40b132
    cmsg->poolp_is_ours = poolp_is_ours;
Packit 40b132
    cmsg->refCount = 1;
Packit 40b132
Packit 40b132
    if (mark)
Packit 40b132
	PORT_ArenaUnmark(poolp, mark);
Packit 40b132
Packit 40b132
    return cmsg;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_SetEncodingParams - set up a CMS message object for encoding or decoding
Packit 40b132
 *
Packit 40b132
 * "cmsg" - message object
Packit 40b132
 * "pwfn", pwfn_arg" - callback function for getting token password
Packit 40b132
 * "decrypt_key_cb", "decrypt_key_cb_arg" - callback function for getting bulk key for encryptedData
Packit 40b132
 * "detached_digestalgs", "detached_digests" - digests from detached content
Packit 40b132
 */
Packit 40b132
void
Packit 40b132
NSS_CMSMessage_SetEncodingParams(NSSCMSMessage *cmsg,
Packit 40b132
			PK11PasswordFunc pwfn, void *pwfn_arg,
Packit 40b132
			NSSCMSGetDecryptKeyCallback decrypt_key_cb, void *decrypt_key_cb_arg,
Packit 40b132
			SECAlgorithmID **detached_digestalgs, SECItem **detached_digests)
Packit 40b132
{
Packit 40b132
    if (pwfn)
Packit 40b132
	PK11_SetPasswordFunc(pwfn);
Packit 40b132
    cmsg->pwfn_arg = pwfn_arg;
Packit 40b132
    cmsg->decrypt_key_cb = decrypt_key_cb;
Packit 40b132
    cmsg->decrypt_key_cb_arg = decrypt_key_cb_arg;
Packit 40b132
    cmsg->detached_digestalgs = detached_digestalgs;
Packit 40b132
    cmsg->detached_digests = detached_digests;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_Destroy - destroy a CMS message and all of its sub-pieces.
Packit 40b132
 */
Packit 40b132
void
Packit 40b132
NSS_CMSMessage_Destroy(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    PORT_Assert (cmsg->refCount > 0);
Packit 40b132
    if (cmsg->refCount <= 0)	/* oops */
Packit 40b132
	return;
Packit 40b132
Packit 40b132
    cmsg->refCount--;		/* thread safety? */
Packit 40b132
    if (cmsg->refCount > 0)
Packit 40b132
	return;
Packit 40b132
Packit 40b132
    NSS_CMSContentInfo_Destroy(&(cmsg->contentInfo));
Packit 40b132
Packit 40b132
    /* if poolp is not NULL, cmsg is the owner of its arena */
Packit 40b132
    if (cmsg->poolp_is_ours)
Packit 40b132
	PORT_FreeArena (cmsg->poolp, PR_FALSE);	/* XXX clear it? */
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_Copy - return a copy of the given message. 
Packit 40b132
 *
Packit 40b132
 * The copy may be virtual or may be real -- either way, the result needs
Packit 40b132
 * to be passed to NSS_CMSMessage_Destroy later (as does the original).
Packit 40b132
 */
Packit 40b132
NSSCMSMessage *
Packit 40b132
NSS_CMSMessage_Copy(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    if (cmsg == NULL)
Packit 40b132
	return NULL;
Packit 40b132
Packit 40b132
    PORT_Assert (cmsg->refCount > 0);
Packit 40b132
Packit 40b132
    cmsg->refCount++; /* XXX chrisk thread safety? */
Packit 40b132
    return cmsg;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_GetArena - return a pointer to the message's arena pool
Packit 40b132
 */
Packit 40b132
PLArenaPool *
Packit 40b132
NSS_CMSMessage_GetArena(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    return cmsg->poolp;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_GetContentInfo - return a pointer to the top level contentInfo
Packit 40b132
 */
Packit 40b132
NSSCMSContentInfo *
Packit 40b132
NSS_CMSMessage_GetContentInfo(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    return &(cmsg->contentInfo);
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * Return a pointer to the actual content. 
Packit 40b132
 * In the case of those types which are encrypted, this returns the *plain* content.
Packit 40b132
 * In case of nested contentInfos, this descends and retrieves the innermost content.
Packit 40b132
 */
Packit 40b132
SECItem *
Packit 40b132
NSS_CMSMessage_GetContent(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    /* this is a shortcut */
Packit 40b132
    NSSCMSContentInfo * cinfo = NSS_CMSMessage_GetContentInfo(cmsg);
Packit 40b132
    SECItem           * pItem = NSS_CMSContentInfo_GetInnerContent(cinfo);
Packit 40b132
    return pItem;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_ContentLevelCount - count number of levels of CMS content objects in this message
Packit 40b132
 *
Packit 40b132
 * CMS data content objects do not count.
Packit 40b132
 */
Packit 40b132
int
Packit 40b132
NSS_CMSMessage_ContentLevelCount(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    int count = 0;
Packit 40b132
    NSSCMSContentInfo *cinfo;
Packit 40b132
Packit 40b132
    /* walk down the chain of contentinfos */
Packit 40b132
    for (cinfo = &(cmsg->contentInfo); cinfo != NULL; ) {
Packit 40b132
	count++;
Packit 40b132
	cinfo = NSS_CMSContentInfo_GetChildContentInfo(cinfo);
Packit 40b132
    }
Packit 40b132
    return count;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_ContentLevel - find content level #n
Packit 40b132
 *
Packit 40b132
 * CMS data content objects do not count.
Packit 40b132
 */
Packit 40b132
NSSCMSContentInfo *
Packit 40b132
NSS_CMSMessage_ContentLevel(NSSCMSMessage *cmsg, int n)
Packit 40b132
{
Packit 40b132
    int count = 0;
Packit 40b132
    NSSCMSContentInfo *cinfo;
Packit 40b132
Packit 40b132
    /* walk down the chain of contentinfos */
Packit 40b132
    for (cinfo = &(cmsg->contentInfo); cinfo != NULL && count < n; cinfo = NSS_CMSContentInfo_GetChildContentInfo(cinfo)) {
Packit 40b132
	count++;
Packit 40b132
    }
Packit 40b132
Packit 40b132
    return cinfo;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_ContainsCertsOrCrls - see if message contains certs along the way
Packit 40b132
 */
Packit 40b132
PRBool
Packit 40b132
NSS_CMSMessage_ContainsCertsOrCrls(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    NSSCMSContentInfo *cinfo;
Packit 40b132
Packit 40b132
    /* descend into CMS message */
Packit 40b132
    for (cinfo = &(cmsg->contentInfo); cinfo != NULL; cinfo = NSS_CMSContentInfo_GetChildContentInfo(cinfo)) {
Packit 40b132
	if (!NSS_CMSType_IsData(NSS_CMSContentInfo_GetContentTypeTag(cinfo)))
Packit 40b132
	    continue;	/* next level */
Packit 40b132
	
Packit 40b132
	if (NSS_CMSSignedData_ContainsCertsOrCrls(cinfo->content.signedData))
Packit 40b132
	    return PR_TRUE;
Packit 40b132
	/* callback here for generic wrappers? */
Packit 40b132
    }
Packit 40b132
    return PR_FALSE;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_IsEncrypted - see if message contains a encrypted submessage
Packit 40b132
 */
Packit 40b132
PRBool
Packit 40b132
NSS_CMSMessage_IsEncrypted(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    NSSCMSContentInfo *cinfo;
Packit 40b132
Packit 40b132
    /* walk down the chain of contentinfos */
Packit 40b132
    for (cinfo = &(cmsg->contentInfo); cinfo != NULL; cinfo = NSS_CMSContentInfo_GetChildContentInfo(cinfo))
Packit 40b132
    {
Packit 40b132
	switch (NSS_CMSContentInfo_GetContentTypeTag(cinfo)) {
Packit 40b132
	case SEC_OID_PKCS7_ENVELOPED_DATA:
Packit 40b132
	case SEC_OID_PKCS7_ENCRYPTED_DATA:
Packit 40b132
	    return PR_TRUE;
Packit 40b132
	default:
Packit 40b132
	    /* callback here for generic wrappers? */
Packit 40b132
	    break;
Packit 40b132
	}
Packit 40b132
    }
Packit 40b132
    return PR_FALSE;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_IsSigned - see if message contains a signed submessage
Packit 40b132
 *
Packit 40b132
 * If the CMS message has a SignedData with a signature (not just a SignedData)
Packit 40b132
 * return true; false otherwise.  This can/should be called before calling
Packit 40b132
 * VerifySignature, which will always indicate failure if no signature is
Packit 40b132
 * present, but that does not mean there even was a signature!
Packit 40b132
 * Note that the content itself can be empty (detached content was sent
Packit 40b132
 * another way); it is the presence of the signature that matters.
Packit 40b132
 */
Packit 40b132
PRBool
Packit 40b132
NSS_CMSMessage_IsSigned(NSSCMSMessage *cmsg)
Packit 40b132
{
Packit 40b132
    NSSCMSContentInfo *cinfo;
Packit 40b132
Packit 40b132
    /* walk down the chain of contentinfos */
Packit 40b132
    for (cinfo = &(cmsg->contentInfo); cinfo != NULL; cinfo = NSS_CMSContentInfo_GetChildContentInfo(cinfo))
Packit 40b132
    {
Packit 40b132
	switch (NSS_CMSContentInfo_GetContentTypeTag(cinfo)) {
Packit 40b132
	case SEC_OID_PKCS7_SIGNED_DATA:
Packit 40b132
	    if (!NSS_CMSArray_IsEmpty((void **)cinfo->content.signedData->signerInfos))
Packit 40b132
		return PR_TRUE;
Packit 40b132
	    break;
Packit 40b132
	default:
Packit 40b132
	    /* callback here for generic wrappers? */
Packit 40b132
	    break;
Packit 40b132
	}
Packit 40b132
    }
Packit 40b132
    return PR_FALSE;
Packit 40b132
}
Packit 40b132
Packit 40b132
/*
Packit 40b132
 * NSS_CMSMessage_IsContentEmpty - see if content is empty
Packit 40b132
 *
Packit 40b132
 * returns PR_TRUE is innermost content length is < minLen
Packit 40b132
 * XXX need the encrypted content length (why?)
Packit 40b132
 */
Packit 40b132
PRBool
Packit 40b132
NSS_CMSMessage_IsContentEmpty(NSSCMSMessage *cmsg, unsigned int minLen)
Packit 40b132
{
Packit 40b132
    SECItem *item = NULL;
Packit 40b132
Packit 40b132
    if (cmsg == NULL)
Packit 40b132
	return PR_TRUE;
Packit 40b132
Packit 40b132
    item = NSS_CMSContentInfo_GetContent(NSS_CMSMessage_GetContentInfo(cmsg));
Packit 40b132
Packit 40b132
    if (!item) {
Packit 40b132
	return PR_TRUE;
Packit 40b132
    } else if(item->len <= minLen) {
Packit 40b132
	return PR_TRUE;
Packit 40b132
    }
Packit 40b132
Packit 40b132
    return PR_FALSE;
Packit 40b132
}