Blame libarchive/archive_read_add_passphrase.c

Packit 08bd4c
/*-
Packit 08bd4c
 * Copyright (c) 2014 Michihiro NAKAJIMA
Packit 08bd4c
 * All rights reserved.
Packit 08bd4c
 *
Packit 08bd4c
 * Redistribution and use in source and binary forms, with or without
Packit 08bd4c
 * modification, are permitted provided that the following conditions
Packit 08bd4c
 * are met:
Packit 08bd4c
 * 1. Redistributions of source code must retain the above copyright
Packit 08bd4c
 *    notice, this list of conditions and the following disclaimer.
Packit 08bd4c
 * 2. Redistributions in binary form must reproduce the above copyright
Packit 08bd4c
 *    notice, this list of conditions and the following disclaimer in the
Packit 08bd4c
 *    documentation and/or other materials provided with the distribution.
Packit 08bd4c
 *
Packit 08bd4c
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
Packit 08bd4c
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
Packit 08bd4c
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Packit 08bd4c
 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
Packit 08bd4c
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
Packit 08bd4c
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit 08bd4c
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit 08bd4c
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit 08bd4c
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
Packit 08bd4c
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Packit 08bd4c
 */
Packit 08bd4c
Packit 08bd4c
#include "archive_platform.h"
Packit 08bd4c
__FBSDID("$FreeBSD$");
Packit 08bd4c
Packit 08bd4c
#ifdef HAVE_ERRNO_H
Packit 08bd4c
#include <errno.h>
Packit 08bd4c
#endif
Packit 08bd4c
#include "archive_read_private.h"
Packit 08bd4c
Packit 08bd4c
static void
Packit 08bd4c
add_passphrase_to_tail(struct archive_read *a,
Packit 08bd4c
    struct archive_read_passphrase *p)
Packit 08bd4c
{
Packit 08bd4c
	*a->passphrases.last = p;
Packit 08bd4c
	a->passphrases.last = &p->next;
Packit 08bd4c
	p->next = NULL;
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static struct archive_read_passphrase *
Packit 08bd4c
remove_passphrases_from_head(struct archive_read *a)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_read_passphrase *p;
Packit 08bd4c
Packit 08bd4c
	p = a->passphrases.first;
Packit 08bd4c
	if (p != NULL)
Packit 08bd4c
		a->passphrases.first = p->next;
Packit 08bd4c
	return (p);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static void
Packit 08bd4c
insert_passphrase_to_head(struct archive_read *a,
Packit 08bd4c
    struct archive_read_passphrase *p)
Packit 08bd4c
{
Packit 08bd4c
	p->next = a->passphrases.first;
Packit 08bd4c
	a->passphrases.first = p;
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static struct archive_read_passphrase *
Packit 08bd4c
new_read_passphrase(struct archive_read *a, const char *passphrase)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_read_passphrase *p;
Packit 08bd4c
Packit 08bd4c
	p = malloc(sizeof(*p));
Packit 08bd4c
	if (p == NULL) {
Packit 08bd4c
		archive_set_error(&a->archive, ENOMEM,
Packit 08bd4c
		    "Can't allocate memory");
Packit 08bd4c
		return (NULL);
Packit 08bd4c
	}
Packit 08bd4c
	p->passphrase = strdup(passphrase);
Packit 08bd4c
	if (p->passphrase == NULL) {
Packit 08bd4c
		free(p);
Packit 08bd4c
		archive_set_error(&a->archive, ENOMEM,
Packit 08bd4c
		    "Can't allocate memory");
Packit 08bd4c
		return (NULL);
Packit 08bd4c
	}
Packit 08bd4c
	return (p);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
int
Packit 08bd4c
archive_read_add_passphrase(struct archive *_a, const char *passphrase)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_read *a = (struct archive_read *)_a;
Packit 08bd4c
	struct archive_read_passphrase *p;
Packit 08bd4c
Packit 08bd4c
	archive_check_magic(_a, ARCHIVE_READ_MAGIC, ARCHIVE_STATE_NEW,
Packit 08bd4c
		"archive_read_add_passphrase");
Packit 08bd4c
Packit 08bd4c
	if (passphrase == NULL || passphrase[0] == '\0') {
Packit 08bd4c
		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
Packit 08bd4c
		    "Empty passphrase is unacceptable");
Packit 08bd4c
		return (ARCHIVE_FAILED);
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	p = new_read_passphrase(a, passphrase);
Packit 08bd4c
	if (p == NULL)
Packit 08bd4c
		return (ARCHIVE_FATAL);
Packit 08bd4c
	add_passphrase_to_tail(a, p);
Packit 08bd4c
Packit 08bd4c
	return (ARCHIVE_OK);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
int
Packit 08bd4c
archive_read_set_passphrase_callback(struct archive *_a, void *client_data,
Packit 08bd4c
    archive_passphrase_callback *cb)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_read *a = (struct archive_read *)_a;
Packit 08bd4c
Packit 08bd4c
	archive_check_magic(_a, ARCHIVE_READ_MAGIC, ARCHIVE_STATE_NEW,
Packit 08bd4c
		"archive_read_set_passphrase_callback");
Packit 08bd4c
Packit 08bd4c
	a->passphrases.callback = cb;
Packit 08bd4c
	a->passphrases.client_data = client_data;
Packit 08bd4c
	return (ARCHIVE_OK);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Call this in advance when you start to get a passphrase for decryption
Packit 08bd4c
 * for a entry.
Packit 08bd4c
 */
Packit 08bd4c
void
Packit 08bd4c
__archive_read_reset_passphrase(struct archive_read *a)
Packit 08bd4c
{
Packit 08bd4c
Packit 08bd4c
	a->passphrases.candidate = -1;
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Get a passphrase for decryption.
Packit 08bd4c
 */
Packit 08bd4c
const char *
Packit 08bd4c
__archive_read_next_passphrase(struct archive_read *a)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_read_passphrase *p;
Packit 08bd4c
	const char *passphrase;
Packit 08bd4c
Packit 08bd4c
	if (a->passphrases.candidate < 0) {
Packit 08bd4c
		/* Count out how many passphrases we have. */
Packit 08bd4c
		int cnt = 0;
Packit 08bd4c
Packit 08bd4c
		for (p = a->passphrases.first; p != NULL; p = p->next)
Packit 08bd4c
			cnt++;
Packit 08bd4c
		a->passphrases.candidate = cnt;
Packit 08bd4c
		p = a->passphrases.first;
Packit 08bd4c
	} else if (a->passphrases.candidate > 1) {
Packit 08bd4c
		/* Rotate a passphrase list. */
Packit 08bd4c
		a->passphrases.candidate--;
Packit 08bd4c
		p = remove_passphrases_from_head(a);
Packit 08bd4c
		add_passphrase_to_tail(a, p);
Packit 08bd4c
		/* Pick a new passphrase candidate up. */
Packit 08bd4c
		p = a->passphrases.first;
Packit 08bd4c
	} else if (a->passphrases.candidate == 1) {
Packit 08bd4c
		/* This case is that all candidates failed to decrypt. */
Packit 08bd4c
		a->passphrases.candidate = 0;
Packit 08bd4c
		if (a->passphrases.first->next != NULL) {
Packit 08bd4c
			/* Rotate a passphrase list. */
Packit 08bd4c
			p = remove_passphrases_from_head(a);
Packit 08bd4c
			add_passphrase_to_tail(a, p);
Packit 08bd4c
		}
Packit 08bd4c
		p = NULL;
Packit 08bd4c
	} else  /* There is no passphrase candidate. */
Packit 08bd4c
		p = NULL;
Packit 08bd4c
Packit 08bd4c
	if (p != NULL)
Packit 08bd4c
		passphrase = p->passphrase;
Packit 08bd4c
	else if (a->passphrases.callback != NULL) {
Packit 08bd4c
		/* Get a passphrase through a call-back function
Packit 08bd4c
		 * since we tried all passphrases out or we don't
Packit 08bd4c
		 * have it. */
Packit 08bd4c
		passphrase = a->passphrases.callback(&a->archive,
Packit 08bd4c
		    a->passphrases.client_data);
Packit 08bd4c
		if (passphrase != NULL) {
Packit 08bd4c
			p = new_read_passphrase(a, passphrase);
Packit 08bd4c
			if (p == NULL)
Packit 08bd4c
				return (NULL);
Packit 08bd4c
			insert_passphrase_to_head(a, p);
Packit 08bd4c
			a->passphrases.candidate = 1;
Packit 08bd4c
		}
Packit 08bd4c
	} else
Packit 08bd4c
		passphrase = NULL;
Packit 08bd4c
Packit 08bd4c
	return (passphrase);
Packit 08bd4c
}