root/openpgpsdk/trunk/tests/test_rsa_signature.c

/*
 * Copyright (c) 2005-2008 Nominet UK (www.nic.uk)
 * All rights reserved.
 * Contributors: Ben Laurie, Rachel Willmer. The Contributors have asserted
 * their moral rights under the UK Copyright Design and Patents Act 1988 to
 * be recorded as the authors of this copyright work.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. 
 * 
 * You may obtain a copy of the License at 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * 
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "CUnit/Basic.h"

#include <openpgpsdk/types.h>
#include "openpgpsdk/keyring.h"
#include <openpgpsdk/armour.h>
#include "openpgpsdk/packet.h"
#include "openpgpsdk/packet-parse.h"
#include "openpgpsdk/packet-show.h"
#include "openpgpsdk/util.h"
#include "openpgpsdk/std_print.h"
#include "openpgpsdk/readerwriter.h"
#include "openpgpsdk/validate.h"

// \todo change this once we know it works
#include "../src/lib/parse_local.h"

#include "tests.h"

static int debug=0;

static char *filename_rsa_noarmour_nopassphrase="ops_rsa_signed_noarmour_nopassphrase.txt";
static char *filename_rsa_noarmour_passphrase="ops_rsa_signed_noarmour_passphrase.txt";
static char *filename_rsa_armour_nopassphrase="ops_rsa_signed_armour_nopassphrase.txt";
static char *filename_rsa_armour_passphrase="ops_rsa_signed_armour_passphrase.txt";
static char *filename_rsa_clearsign_file_nopassphrase="ops_rsa_signed_clearsign_file_nopassphrase.txt";
static char *filename_rsa_clearsign_file_passphrase="ops_rsa_signed_clearsign_file_passphrase.txt";
static char *filename_rsa_clearsign_buf_nopassphrase="ops_rsa_signed_clearsign_buf_nopassphrase.txt";
static char *filename_rsa_clearsign_buf_passphrase="ops_rsa_signed_clearsign_buf_passphrase.txt";

/* Signature suite initialization.
 * Create temporary directory.
 * Create temporary test files.
 */

int init_suite_rsa_signature(void)
    {
    // Create test files

    create_small_testfile(filename_rsa_noarmour_nopassphrase);
    create_small_testfile(filename_rsa_noarmour_passphrase);
    create_small_testfile(filename_rsa_armour_nopassphrase);
    create_small_testfile(filename_rsa_armour_passphrase);
    create_small_testfile(filename_rsa_clearsign_file_nopassphrase);
    create_small_testfile(filename_rsa_clearsign_file_passphrase);
    create_small_testfile(filename_rsa_clearsign_buf_nopassphrase);
    create_small_testfile(filename_rsa_clearsign_buf_passphrase);

    // Return success
    return 0;
    }

int clean_suite_rsa_signature(void)
    {
    ops_finish();

    reset_vars();

    return 0;
    }

static void test_rsa_signature_clearsign_file(const char *filename, const ops_secret_key_t *skey)
    {
    char cmd[MAXBUF+1];
    char myfile[MAXBUF+1];
    char signed_file[MAXBUF+1];
    int rtn=0;
    ops_boolean_t overwrite;

    // setup filenames
    snprintf(myfile,sizeof myfile,"%s/%s",dir,filename);
    snprintf(signed_file,sizeof signed_file,"%s.asc",myfile);

    // sign file
    overwrite=ops_true;
    ops_sign_file_as_cleartext(myfile, skey, overwrite);

    /*
     * Validate output
     */

    // Check with OPS

    {
    int fd=0;
    ops_parse_info_t *pinfo=NULL;
    validate_data_cb_arg_t validate_arg;
    ops_validate_result_t* result=ops_mallocz(sizeof (ops_validate_result_t));
    int rtn=0;
    
    if (debug)
        {
        fprintf(stderr,"\n***\n*** Starting to parse for validation\n***\n");
        }
    
    // open signed file
#ifdef WIN32
    fd=open(signed_file,O_RDONLY | O_BINARY);
#else
    fd=open(signed_file,O_RDONLY);
#endif
    if(fd < 0)
        {
        perror(signed_file);
        exit(2);
        }
    
    // Set verification reader and handling options
    
    pinfo=ops_parse_info_new();
    
    memset(&validate_arg,'\0',sizeof validate_arg);
    validate_arg.result=result;
    validate_arg.keyring=&pub_keyring;
    validate_arg.rarg=ops_reader_get_arg_from_pinfo(pinfo);
    
    ops_parse_options(pinfo,OPS_PTAG_SS_ALL,OPS_PARSE_PARSED);
    ops_parse_cb_set(pinfo,callback_verify,&validate_arg);
    ops_reader_set_fd(pinfo,fd);
    pinfo->rinfo.accumulate=ops_true;
    
    // Must de-armour because it's clearsigned
    
    ops_reader_push_dearmour(pinfo,ops_false,ops_false,ops_false);
    
    // Do the verification
    
    rtn=ops_parse(pinfo);
    ops_print_errors(ops_parse_info_get_errors(pinfo));
    CU_ASSERT(rtn==1);
    
    // Tidy up
    //    if (has_armour)
        ops_reader_pop_dearmour(pinfo);
    
    ops_parse_info_delete(pinfo);
    
    close(fd);
    ops_validate_result_free(result);
    }

    // Check signature with GPG
    {

    //snprintf(cmd,sizeof cmd,"%s --verify %s", gpgcmd, signed_file);
    snprintf(cmd,sizeof cmd,"cat %s | %s --verify", signed_file, gpgcmd);
    rtn=system(cmd);
    CU_ASSERT(rtn==0);
    }
    }

static void test_rsa_signature_clearsign_buf(const char *filename, const ops_secret_key_t *skey)
    {
    char cmd[MAXBUF+1];
    char myfile[MAXBUF+1];
    char signed_file[MAXBUF+1];
    int rtn=0;
    ops_memory_t *input=NULL;
    ops_memory_t *output=NULL;
    ops_boolean_t overwrite;

    // setup filenames 
    // (we are testing the function which signs a buf, but still want
    // to read/write the buffers from/to files for external viewing

    snprintf(myfile,sizeof myfile,"%s/%s",dir,filename);
    snprintf(signed_file,sizeof signed_file,"%s.asc",myfile);

    // read file contents
    input=ops_write_buf_from_file(myfile);

    // sign file
    ops_sign_buf_as_cleartext((const char *)ops_memory_get_data(input),ops_memory_get_length(input),&output,skey);

    // write to file
    overwrite=ops_true;
    ops_write_file_from_buf(signed_file, (const char*)ops_memory_get_data(output),ops_memory_get_length(output),overwrite);

    /*
     * Validate output
     */

    // Check with OPS

    {
    int fd=0;
    ops_parse_info_t *pinfo=NULL;
    validate_data_cb_arg_t validate_arg;
    ops_validate_result_t* result=ops_mallocz(sizeof (ops_validate_result_t));

    int rtn=0;
    
    if (debug)
        {
        fprintf(stderr,"\n***\n*** Starting to parse for validation\n***\n");
        }
    
    // open signed file
#ifdef WIN32
    fd=open(signed_file,O_RDONLY | O_BINARY);
#else
    fd=open(signed_file,O_RDONLY);
#endif
    if(fd < 0)
        {
        perror(signed_file);
        exit(2);
        }
    
    // Set verification reader and handling options
    
    pinfo=ops_parse_info_new();
    
    memset(&validate_arg,'\0',sizeof validate_arg);
    validate_arg.result=result;
    validate_arg.keyring=&pub_keyring;
    validate_arg.rarg=ops_reader_get_arg_from_pinfo(pinfo);
    
    ops_parse_options(pinfo,OPS_PTAG_SS_ALL,OPS_PARSE_PARSED);
    ops_parse_cb_set(pinfo,callback_verify,&validate_arg);
    ops_reader_set_fd(pinfo,fd);
    pinfo->rinfo.accumulate=ops_true;
    
    // Must de-armour because it's clearsigned
    
    ops_reader_push_dearmour(pinfo,ops_false,ops_false,ops_false);
    
    // Do the verification
    
    rtn=ops_parse(pinfo);
    ops_print_errors(ops_parse_info_get_errors(pinfo));
    CU_ASSERT(rtn==1);
    
    // Tidy up
    //    if (has_armour)
        ops_reader_pop_dearmour(pinfo);
    
    ops_parse_info_delete(pinfo);
    
    close(fd);
    ops_validate_result_free(result);
    }

    // Check signature with GPG
    {

    snprintf(cmd,sizeof cmd,"%s --verify %s", gpgcmd, signed_file);
    rtn=system(cmd);
    CU_ASSERT(rtn==0);
    }
    }

static void test_rsa_signature_sign(const int use_armour, const char *filename, const ops_secret_key_t *skey)
    {
    char cmd[MAXBUF+1];
    char myfile[MAXBUF+1];
    char signed_file[MAXBUF+1];
    char *suffix= use_armour ? "asc" : "gpg";
    int rtn=0;
    ops_boolean_t overwrite=ops_true;

    // filenames
    snprintf(myfile,sizeof myfile,"%s/%s",dir,filename);
    snprintf(signed_file,sizeof signed_file,"%s.%s",myfile,suffix);

    ops_sign_file(myfile, signed_file, skey, use_armour, overwrite);
    //ops_sign_file(myfile, NULL, skey, use_armour, overwrite);

    /*
     * Validate output
     */

    // Check with OPS

    {
    int fd=0;
    ops_parse_info_t *pinfo=NULL;
    validate_data_cb_arg_t validate_arg;
    ops_validate_result_t* result=ops_mallocz(sizeof (ops_validate_result_t));;
    int rtn=0;
    
    if (debug)
        {
        fprintf(stderr,"\n***\n*** Starting to parse for validation\n***\n");
        }
    
    // open signed file
#ifdef WIN32
    fd=open(signed_file,O_RDONLY | O_BINARY);
#else
    fd=open(signed_file,O_RDONLY);
#endif
    if(fd < 0)
        {
        perror(signed_file);
        exit(2);
        }
    
    // Set verification reader and handling options
    
    pinfo=ops_parse_info_new();
    
    memset(&validate_arg,'\0',sizeof validate_arg);
    validate_arg.result=result;
    validate_arg.keyring=&pub_keyring;
    validate_arg.rarg=ops_reader_get_arg_from_pinfo(pinfo);
    
    ops_parse_options(pinfo,OPS_PTAG_SS_ALL,OPS_PARSE_PARSED);
    ops_parse_cb_set(pinfo,callback_verify,&validate_arg);
    ops_reader_set_fd(pinfo,fd);
    pinfo->rinfo.accumulate=ops_true;
    
    // Set up armour/passphrase options
    
    if (use_armour)
        ops_reader_push_dearmour(pinfo,ops_false,ops_false,ops_false);
    
    // Do the verification
    
    rtn=ops_parse_and_print_errors(pinfo);
    CU_ASSERT(rtn==1);
    
    // Tidy up
    if (use_armour)
        ops_reader_pop_dearmour(pinfo);
    
    ops_parse_info_delete(pinfo);
    
    close(fd);
    ops_validate_result_free(result);
    }

    // Check signature with GPG
    {

    snprintf(cmd,sizeof cmd,"%s --verify %s", gpgcmd, signed_file);
    rtn=system(cmd);
    CU_ASSERT(rtn==0);
    }
    }

static void test_rsa_signature_sign_memory(const int use_armour, const void* input, const int input_len, const ops_secret_key_t *skey)
    {
    int rtn=0;
    ops_memory_t* mem=NULL;
    ops_parse_info_t *pinfo=NULL;
    validate_data_cb_arg_t validate_arg;
    ops_validate_result_t* result=ops_mallocz(sizeof (ops_validate_result_t));
    

    // filenames

    mem=ops_sign_mem(input, input_len, OPS_SIG_TEXT, skey, use_armour);

    /*
     * Validate output
     */

    if (debug)
        {
        fprintf(stderr,"\n***\n*** Starting to parse for validation\n***\n");
        }
    
    ops_write_file_from_buf("/tmp/memory.asc", ops_memory_get_data(mem), ops_memory_get_length(mem),ops_true);

    // Set verification reader and handling options
    
    ops_setup_memory_read(&pinfo, mem, &validate_arg, callback_verify);
    
    memset(&validate_arg,'\0',sizeof validate_arg);
    validate_arg.result=result;
    validate_arg.keyring=&pub_keyring;
    validate_arg.rarg=ops_reader_get_arg_from_pinfo(pinfo);
    
    ops_parse_options(pinfo,OPS_PTAG_SS_ALL,OPS_PARSE_PARSED);
    pinfo->rinfo.accumulate=ops_true;
    
    // Set up armour/passphrase options
    
    if (use_armour)
        ops_reader_push_dearmour(pinfo,ops_false,ops_false,ops_false);
    
    // Do the verification
    
    rtn=ops_parse_and_print_errors(pinfo);
    CU_ASSERT(rtn==1);
    
    // Tidy up
    if (use_armour)
        ops_reader_pop_dearmour(pinfo);
    
    ops_parse_info_delete(pinfo);
    ops_memory_free(mem);
    ops_validate_result_free(result);
    }

static void test_rsa_signature_noarmour_nopassphrase(void)
    {
    unsigned char testdata[MAXBUF];
    int armour=0;
    assert(pub_keyring.nkeys);
    test_rsa_signature_sign(armour,filename_rsa_noarmour_nopassphrase, alpha_skey);
    create_testdata("test_rsa_signature_noarmour_nopassphrase",testdata, MAXBUF);
    test_rsa_signature_sign_memory(armour,testdata,MAXBUF, alpha_skey);
    }

static void test_rsa_signature_noarmour_passphrase(void)
    {
    unsigned char testdata[MAXBUF];
    int armour=0;
    assert(pub_keyring.nkeys);
    test_rsa_signature_sign(armour,filename_rsa_noarmour_passphrase, bravo_skey);

    create_testdata("test_rsa_signature_noarmour_passphrase",testdata, MAXBUF);
    test_rsa_signature_sign_memory(armour,testdata,MAXBUF, bravo_skey);
    }

static void test_rsa_signature_armour_nopassphrase(void)
    {
    unsigned char testdata[MAXBUF];
    int armour=1;
    assert(pub_keyring.nkeys);
    test_rsa_signature_sign(armour,filename_rsa_armour_nopassphrase, alpha_skey);

    create_testdata("test_rsa_signature_armour_nopassphrase",testdata, MAXBUF);
    test_rsa_signature_sign_memory(armour,testdata,MAXBUF, alpha_skey);
    }

static void test_rsa_signature_armour_passphrase(void)
    {
    unsigned char testdata[MAXBUF];

    int armour=1;
    assert(pub_keyring.nkeys);
    test_rsa_signature_sign(armour,filename_rsa_armour_passphrase, bravo_skey);

    create_testdata("test_rsa_signature_armour_passphrase",testdata, MAXBUF);
    test_rsa_signature_sign_memory(armour,testdata,MAXBUF, bravo_skey);
    }

static void test_rsa_signature_clearsign_file_nopassphrase(void)
    {
    assert(pub_keyring.nkeys);
    test_rsa_signature_clearsign_file(filename_rsa_clearsign_file_nopassphrase, alpha_skey);
    }

static void test_rsa_signature_clearsign_file_passphrase(void)
    {
    assert(pub_keyring.nkeys);
    test_rsa_signature_clearsign_file(filename_rsa_clearsign_file_passphrase, bravo_skey);
    }

static void test_rsa_signature_clearsign_buf_nopassphrase(void)
    {
    assert(pub_keyring.nkeys);
    test_rsa_signature_clearsign_buf(filename_rsa_clearsign_buf_nopassphrase, alpha_skey);
    }

static void test_rsa_signature_clearsign_buf_passphrase(void)
    {
    assert(pub_keyring.nkeys);
    test_rsa_signature_clearsign_buf(filename_rsa_clearsign_buf_passphrase, bravo_skey);
    }

static void test_todo(void)
    {
    CU_FAIL("Test TODO: Test large files");
    CU_FAIL("Test TODO: Sign with V3 signature?");
    CU_FAIL("Test TODO: Use other hash algorithms?");
    CU_FAIL("Test TODO: Check for key/signature expiry");
    CU_FAIL("Test TODO: Check for key/signature revocation");
    }

static int add_tests(CU_pSuite suite)
    {
    // add tests to suite
    
    if (NULL == CU_add_test(suite, "Unarmoured, no passphrase", test_rsa_signature_noarmour_nopassphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Unarmoured, passphrase", test_rsa_signature_noarmour_passphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Clearsigned file, no passphrase", test_rsa_signature_clearsign_file_nopassphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Clearsigned file, passphrase", test_rsa_signature_clearsign_file_passphrase))
            return 0;

    if (NULL == CU_add_test(suite, "Clearsigned buf, no passphrase", test_rsa_signature_clearsign_buf_nopassphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Clearsigned buf, passphrase", test_rsa_signature_clearsign_buf_passphrase))
            return 0;

    if (NULL == CU_add_test(suite, "Armoured, no passphrase", test_rsa_signature_armour_nopassphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Armoured, passphrase", test_rsa_signature_armour_passphrase))
            return 0;
    
    if (NULL == CU_add_test(suite, "Tests to be implemented", test_todo))
            return 0;
    
    return 1;
}

CU_pSuite suite_rsa_signature()
{
    CU_pSuite suite = NULL;

    suite = CU_add_suite("RSA Signature Suite", init_suite_rsa_signature, clean_suite_rsa_signature);
    if (!suite)
            return NULL;

    if (!add_tests(suite))
        return NULL;

    return suite;
    }


// EOF