Skip to content

Commit

Permalink
Add some debug logging.
Browse files Browse the repository at this point in the history
  • Loading branch information
ni4 committed Nov 14, 2023
1 parent 1f7759f commit 6fd3d71
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 2 deletions.
3 changes: 3 additions & 0 deletions src/lib/rnp.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3132,14 +3132,17 @@ rnp_verify_dest_provider(pgp_parse_handler_t *handler,
const char * filename,
uint32_t mtime)
{
RNP_LOG("here");
rnp_op_verify_t op = (rnp_op_verify_t) handler->param;
if (!op->output) {
RNP_LOG("here");
return false;
}
*dst = &(op->output->dst);
*closedst = false;
op->filename = filename ? std::string(filename) : "";
op->file_mtime = mtime;
RNP_LOG("here");
return true;
}

Expand Down
12 changes: 11 additions & 1 deletion src/librepgp/stream-common.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,18 @@ bool
src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
{
size_t left = len;
size_t read;
size_t read = 0;
pgp_source_cache_t *cache = src->cache;
bool readahead = cache ? cache->readahead : false;

if (src->error) {
RNP_LOG("read error");
return false;
}

if (src->eof || (len == 0)) {
*readres = 0;
RNP_LOG("read eof");
return true;
}

Expand Down Expand Up @@ -96,11 +98,14 @@ src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
// If there is no cache or chunk is larger then read directly
if (!src->read(src, buf, left, &read)) {
src->error = 1;
RNP_LOG("here");
return false;
}
// RNP_LOG("here: %p %zu", src->read, read);

Check notice

Code scanning / CodeQL

Commented-out code Note

This comment appears to contain commented-out code.
if (!read) {
src->eof = 1;
len = len - left;
RNP_LOG("here: %zu", len);
goto finish;
}
left -= read;
Expand All @@ -109,11 +114,14 @@ src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
// Try to fill the cache to avoid small reads
if (!src->read(src, &cache->buf[0], sizeof(cache->buf), &read)) {
src->error = 1;
RNP_LOG("here");
return false;
}
// RNP_LOG("here: %p %zu", src->read, read);

Check notice

Code scanning / CodeQL

Commented-out code Note

This comment appears to contain commented-out code.
if (!read) {
src->eof = 1;
len = len - left;
RNP_LOG("here: %zu", len);
goto finish;
} else if (read < left) {
memcpy(buf, &cache->buf[0], read);
Expand All @@ -133,6 +141,7 @@ src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
if (src->knownsize && (src->readb == src->size)) {
src->eof = 1;
}
//RNP_LOG("read bytes: %zu", len);

Check notice

Code scanning / CodeQL

Commented-out code Note

This comment appears to contain commented-out code.
*readres = len;
return true;
}
Expand Down Expand Up @@ -386,6 +395,7 @@ file_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
if (rres < 0) {
return false;
}
RNP_LOG("%zu from %zu", (size_t) rres, len);
*readres = rres;
return true;
}
Expand Down
58 changes: 57 additions & 1 deletion src/librepgp/stream-parse.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ is_pgp_source(pgp_source_t &src)
static bool
partial_pkt_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
{
RNP_LOG("partial %p start: %zu", src, len);
if (src->eof) {
*readres = 0;
return true;
Expand All @@ -242,29 +243,38 @@ partial_pkt_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
size_t write = 0;
while (len > 0) {
if (!param->pleft && param->last) {
RNP_LOG("partial finish: %zu", write);
// we have the last chunk
*readres = write;
return true;
}
if (!param->pleft) {
// reading next chunk
if (!stream_read_partial_chunk_len(param->readsrc, &read, &param->last)) {
RNP_LOG("partial chunk len failure");
return false;
}
RNP_LOG("partial new chunk: %zu %d", read, (int) param->last);
param->psize = read;
param->pleft = read;
}

if (!param->pleft) {
RNP_LOG("partial zero chunk");
*readres = write;
return true;
}

read = param->pleft > len ? len : param->pleft;
RNP_LOG("partial reading %zu from %p (%d)",
read,
param->readsrc,
(int) param->readsrc->type);
if (!src_read(param->readsrc, buf, read, &read)) {
RNP_LOG("failed to read data chunk");
return false;
}
RNP_LOG("partial read %zu", read);
if (!read) {
RNP_LOG("unexpected eof");
*readres = write;
Expand All @@ -276,6 +286,7 @@ partial_pkt_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
param->pleft -= read;
}

RNP_LOG("partial end of cycle");
*readres = write;
return true;
}
Expand Down Expand Up @@ -325,9 +336,13 @@ literal_src_read(pgp_source_t *src, void *buf, size_t len, size_t *read)
{
pgp_source_literal_param_t *param = (pgp_source_literal_param_t *) src->param;
if (!param) {
RNP_LOG("here");
return false;
}
return src_read(param->pkt.readsrc, buf, len, read);
RNP_LOG("reading %zu bytes from literal.");

Check warning

Code scanning / CodeQL

Too few arguments to formatting function Medium

Format for fprintf (in a macro expansion) expects 1 arguments but given 0
auto res = src_read(param->pkt.readsrc, buf, len, read);
RNP_LOG("read %zu bytes from literal.", *read);
return res;
}

static void
Expand All @@ -349,6 +364,7 @@ literal_src_close(pgp_source_t *src)
static bool
compressed_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
{
RNP_LOG("starting %p compressed read: %zu", src, len);
pgp_source_compressed_param_t *param = (pgp_source_compressed_param_t *) src->param;
if (!param) {
return false;
Expand All @@ -375,16 +391,22 @@ compressed_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
while ((param->z.avail_out > 0) && (!param->zend)) {
if (param->z.avail_in == 0) {
size_t read = 0;
RNP_LOG("reading %zu from %p (%d)",
sizeof(param->in),
param->pkt.readsrc,
(int) param->pkt.readsrc->type);
if (!src_read(param->pkt.readsrc, param->in, sizeof(param->in), &read)) {
RNP_LOG("failed to read data");
return false;
}
RNP_LOG("read %zu from underlying", read);
param->z.next_in = param->in;
param->z.avail_in = read;
param->inlen = read;
param->inpos = 0;
}
int ret = inflate(&param->z, Z_SYNC_FLUSH);
RNP_LOG("called inflate: %d", ret);
if (ret == Z_STREAM_END) {
param->zend = true;
if (param->z.avail_in > 0) {
Expand All @@ -403,6 +425,7 @@ compressed_src_read(pgp_source_t *src, void *buf, size_t len, size_t *readres)
}
param->inpos = param->z.next_in - param->in;
*readres = len - param->z.avail_out;
RNP_LOG("returning decompressed: %zu", *readres);
return true;
}
#ifdef HAVE_BZLIB_H
Expand Down Expand Up @@ -704,28 +727,35 @@ encrypted_src_read_aead(pgp_source_t *src, void *buf, size_t len, size_t *read)
static bool
encrypted_src_read_cfb(pgp_source_t *src, void *buf, size_t len, size_t *readres)
{
RNP_LOG("here");
pgp_source_encrypted_param_t *param = (pgp_source_encrypted_param_t *) src->param;
if (param == NULL) {
RNP_LOG("here");
return false;
}

if (src->eof) {
*readres = 0;
RNP_LOG("here");
return true;
}

RNP_LOG("here");
size_t read;
if (!src_read(param->pkt.readsrc, buf, len, &read)) {
RNP_LOG("here");
return false;
}
if (!read) {
*readres = 0;
RNP_LOG("here");
return true;
}

bool parsemdc = false;
uint8_t mdcbuf[MDC_V1_SIZE];
if (param->auth_type == rnp::AuthType::MDC) {
RNP_LOG("here");
size_t mdcread = 0;
/* make sure there are always 22 bytes left on input */
if (!src_peek(param->pkt.readsrc, mdcbuf, MDC_V1_SIZE, &mdcread) ||
Expand All @@ -743,10 +773,13 @@ encrypted_src_read_cfb(pgp_source_t *src, void *buf, size_t len, size_t *readres
}
}

RNP_LOG("here");
pgp_cipher_cfb_decrypt(&param->decrypt, (uint8_t *) buf, (uint8_t *) buf, read);
RNP_LOG("here");

if (param->auth_type == rnp::AuthType::MDC) {
try {
RNP_LOG("here");
param->mdc->add(buf, read);

if (parsemdc) {
Expand Down Expand Up @@ -774,6 +807,7 @@ encrypted_src_read_cfb(pgp_source_t *src, void *buf, size_t len, size_t *readres
}
}
*readres = read;
RNP_LOG("here");
return true;
}

Expand Down Expand Up @@ -2338,6 +2372,7 @@ encrypted_read_packet_data(pgp_source_encrypted_param_t *param)
static rnp_result_t
init_encrypted_src(pgp_parse_handler_t *handler, pgp_source_t *src, pgp_source_t *readsrc)
{
RNP_LOG("here");
if (!init_src_common(src, 0)) {
return RNP_ERROR_OUT_OF_MEMORY;
}
Expand All @@ -2354,11 +2389,13 @@ init_encrypted_src(pgp_parse_handler_t *handler, pgp_source_t *src, pgp_source_t
src->type = PGP_STREAM_ENCRYPTED;

/* Read the packet-related information */
RNP_LOG("here");
rnp_result_t errcode = encrypted_read_packet_data(param);
if (errcode) {
goto finish;
}

RNP_LOG("here");
src->read = (!param->use_cfb()
#ifdef ENABLE_CRYPTO_REFRESH
|| param->is_v2_seipd()
Expand All @@ -2374,11 +2411,13 @@ init_encrypted_src(pgp_parse_handler_t *handler, pgp_source_t *src, pgp_source_t
goto finish;
}

RNP_LOG("here");
/* informing handler about the available pubencs/symencs */
if (handler->on_recipients) {
handler->on_recipients(param->pubencs, param->symencs, handler->param);
}

RNP_LOG("here");
bool have_key;
have_key = false;
/* Trying public-key decryption */
Expand Down Expand Up @@ -2456,15 +2495,19 @@ init_encrypted_src(pgp_parse_handler_t *handler, pgp_source_t *src, pgp_source_t

/* Trying password-based decryption */
if (!have_key && !param->symencs.empty()) {
RNP_LOG("here");
rnp::secure_array<char, MAX_PASSWORD_LENGTH> password;
pgp_password_ctx_t pass_ctx(PGP_OP_DECRYPT_SYM);
if (!pgp_request_password(
handler->password_provider, &pass_ctx, password.data(), password.size())) {
errcode = RNP_ERROR_BAD_PASSWORD;
RNP_LOG("here");
goto finish;
}

RNP_LOG("here");
int intres = encrypted_try_password(param, password.data());
RNP_LOG("here: %d", intres);
if (intres > 0) {
have_key = true;
} else if (intres < 0) {
Expand All @@ -2475,13 +2518,16 @@ init_encrypted_src(pgp_parse_handler_t *handler, pgp_source_t *src, pgp_source_t
}

/* report decryption start to the handler */
RNP_LOG("here");
if (handler->on_decryption_info) {
RNP_LOG("here");
handler->on_decryption_info(param->auth_type == rnp::AuthType::MDC,
param->aead_hdr.aalg,
param->salg,
handler->param);
}

RNP_LOG("here");
if (!have_key) {
RNP_LOG("failed to obtain decrypting key or password");
if (!errcode) {
Expand Down Expand Up @@ -2712,6 +2758,7 @@ init_packet_sequence(pgp_processing_ctx_t &ctx, pgp_source_t &src)
pgp_source_t *lsrc = &src;
size_t srcnum = ctx.sources.size();

RNP_LOG("here");
while (1) {
uint8_t ptag = 0;
if (!src_peek_eq(lsrc, &ptag, 1)) {
Expand Down Expand Up @@ -2848,6 +2895,10 @@ process_pgp_source(pgp_parse_handler_t *handler, pgp_source_t &src)
bool closeout = true;
uint8_t * readbuf = NULL;

RNP_LOG("here");
RNP_LOG("encrypted_src_read_cfb: %p", encrypted_src_read_aead);
RNP_LOG("compressed_src_read: %p", compressed_src_read);
RNP_LOG("partial_pkt_src_read: %p", partial_pkt_src_read);
ctx.handler = *handler;
/* Building readers sequence. Checking whether it is binary data */
if (is_pgp_source(src)) {
Expand Down Expand Up @@ -2918,19 +2969,23 @@ process_pgp_source(pgp_parse_handler_t *handler, pgp_source_t &src)
mtime = param->hdr.timestamp;
}

RNP_LOG("here: %s", filename);
if (!handler->dest_provider ||
!handler->dest_provider(handler, &outdest, &closeout, filename, mtime)) {
res = RNP_ERROR_WRITE;
RNP_LOG("here");
goto finish;
}

/* reading the input */
RNP_LOG("starting reading");
while (!decsrc->eof) {
size_t read = 0;
if (!src_read(decsrc, readbuf, PGP_INPUT_CACHE_SIZE, &read)) {
res = RNP_ERROR_GENERIC;
break;
}
RNP_LOG("read raw bytes: %zu", read);
if (!read) {
continue;
}
Expand Down Expand Up @@ -2961,6 +3016,7 @@ process_pgp_source(pgp_parse_handler_t *handler, pgp_source_t &src)
}

finish:
RNP_LOG("finished processing: %x", (int) res);
free(readbuf);
return res;
}

0 comments on commit 6fd3d71

Please sign in to comment.