Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify launching and testing fuzzing tools #366

Merged
merged 6 commits into from
Feb 6, 2019
Merged

Simplify launching and testing fuzzing tools #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8d2ec2e
Use command-line arguments instead of pipes
ilammy Feb 5, 2019
0445a58
Launch trap as a separate command
ilammy Feb 5, 2019
94daa12
Organize fuzzer output into subdirectories
ilammy Feb 5, 2019
569fc66
Link statically against Themis
ilammy Feb 5, 2019
54352f2
fixup! Use command-line arguments instead of pipes
ilammy Feb 6, 2019
81a225d
Human-readable error messages
ilammy Feb 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion tools/afl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,10 @@ in order to add a `${new_tool}` to fuzz test suite.

1. Create `src/${new_tool}.c` file.

It should be a simple C program which reads from standard input,
It should be a simple C program
which accepts a single command-line argument:
a path to the file with input data.
The tool reads the file,
exercises Themis in some way using the input data,
and exits cleanly if the test passes.

Expand Down
21 changes: 8 additions & 13 deletions tools/afl/fuzzy.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,14 @@ FUZZ_PATH = tools/afl
FUZZ_BIN_PATH = $(BIN_PATH)/afl
FUZZ_SRC_PATH = $(FUZZ_PATH)/src
FUZZ_THEMIS_PATH = $(BIN_PATH)/afl-themis
FUZZ_THEMIS_LIB = $(FUZZ_THEMIS_PATH)/lib$(THEMIS_BIN).$(SHARED_EXT)
FUZZ_THEMIS_LIB = $(FUZZ_THEMIS_PATH)/lib$(THEMIS_BIN).a

FUZZ_TOOLS = $(addprefix $(FUZZ_BIN_PATH)/,$(notdir $(wildcard $(FUZZ_PATH)/input/*)))
FUZZ_OBJS = $(patsubst $(FUZZ_SRC_PATH)/%.c,$(FUZZ_BIN_PATH)/%.o,$(wildcard $(FUZZ_SRC_PATH)/*.c))
FUZZ_UTILS = $(filter-out $(addsuffix .o,$(FUZZ_TOOLS)),$(FUZZ_OBJS))

AFL_CFLAGS += $(CFLAGS) -I$(FUZZ_SRC_PATH)
AFL_LDFLAGS += -L$(FUZZ_THEMIS_PATH) -l$(THEMIS_BIN)

# Dynamic loader on Linux requires a bit of help to locate the libraries
ifdef IS_LINUX
AFL_LINKAGE = LD_LIBRARY_PATH="$(abspath $(FUZZ_THEMIS_PATH))"
endif
AFL_LDFLAGS += -L$(FUZZ_THEMIS_PATH) -l$(THEMIS_BIN) -l$(SOTER_BIN) $(LDFLAGS)

# We don't really track dependencies of $(FUZZ_THEMIS_LIB) here,
# so ask our make to rebuild it every time. The recursively called
Expand All @@ -46,7 +41,7 @@ endif

ifdef FUZZ_BIN
FUZZ_INPUT := $(FUZZ_PATH)/input/$(FUZZ_BIN)
FUZZ_OUTPUT := $(FUZZ_BIN_PATH)/output/$(FUZZ_BIN)_$(shell date +"%Y-%m-%d_%H-%M-%S")
FUZZ_OUTPUT := $(FUZZ_BIN_PATH)/output/$(FUZZ_BIN)/$(shell date +"%Y-%m-%d_%H-%M-%S")
endif

# american fuzzy lop is expected to be stopped via SIGINT (usually by pressing
Expand All @@ -56,8 +51,8 @@ fuzz: $(FUZZ_TOOLS)
ifdef FUZZ_BIN
@echo "fuzzing $(FUZZ_BIN)..."
@mkdir -p $(FUZZ_OUTPUT)
@trap 'echo "see $(FUZZ_OUTPUT) for results"' SIGINT && \
$(AFL_LINKAGE) $(AFL_FUZZ) -i $(FUZZ_INPUT) -o $(FUZZ_OUTPUT) $(FUZZ_BIN_PATH)/$(FUZZ_BIN)
@trap 'echo "see $(FUZZ_OUTPUT) for results"' SIGINT ; \
$(AFL_FUZZ) -i $(FUZZ_INPUT) -o $(FUZZ_OUTPUT) $(FUZZ_BIN_PATH)/$(FUZZ_BIN) @@
endif

$(FUZZ_BIN_PATH)/%.o: $(FUZZ_SRC_PATH)/%.c
Expand All @@ -66,11 +61,11 @@ $(FUZZ_BIN_PATH)/%.o: $(FUZZ_SRC_PATH)/%.c
@AFL_QUIET=1 $(AFL_CC) $(AFL_CFLAGS) -c -o $@ $<
@$(PRINT_OK)

$(FUZZ_BIN_PATH)/%: $(FUZZ_BIN_PATH)/%.o $(FUZZ_UTILS) | $(FUZZ_THEMIS_LIB)
$(FUZZ_BIN_PATH)/%: $(FUZZ_BIN_PATH)/%.o $(FUZZ_UTILS) $(FUZZ_THEMIS_LIB)
@mkdir -p $(@D)
@echo -n "link "
@AFL_QUIET=1 $(AFL_LINKAGE) $(AFL_CC) -o $@ $< $(FUZZ_UTILS) $(AFL_LDFLAGS)
@AFL_QUIET=1 $(AFL_CC) -o $@ $< $(FUZZ_UTILS) $(AFL_LDFLAGS)
@$(PRINT_OK)

$(FUZZ_THEMIS_LIB):
@AFL_QUIET=1 make themis_shared CC=$(AFL_CC) BUILD_PATH=$(FUZZ_THEMIS_PATH)
@AFL_QUIET=1 make themis_static CC=$(AFL_CC) BUILD_PATH=$(FUZZ_THEMIS_PATH)
31 changes: 27 additions & 4 deletions tools/afl/src/scell_seal_decrypt.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* limitations under the License.
*/

#include <errno.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
Expand All @@ -23,38 +24,56 @@

#include "readline.h"

int main(void)
int main(int argc, char **argv)
{
themis_status_t err = THEMIS_SUCCESS;

/*
* Read test data.
*/

if (argc != 2)
{
fprintf(stderr, "usage:\n\t%s <input-file>\n", argv[0]);
return 1;
}

FILE* input = fopen(argv[1], "rb");
if (!input)
{
fprintf(stderr, "failed to open %s: %s\n", argv[1], strerror(errno));
return 1;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about to print some message that we expect filepath in one required argument to avoid the need to dive into sources to understand why exit status 1?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH, the exit statuses are meaningless now. AFL ignores them completely, it's in only for the crashes. I hoped that it might discriminate between different exit codes, but nope.

You're right. I guess I'll add some messages to stderr when we exit with non-zero status. This should make it easier for humans with the tools.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lagovas here you go. Now the tools print a "usage" line if the command-line is incorrect, as well as some comments on why exactly we're exiting with non-zero status or aborting.

}

uint8_t *master_key_bytes = NULL;
size_t master_key_size = 0;

if (read_line_binary(stdin, &master_key_bytes, &master_key_size))
if (read_line_binary(input, &master_key_bytes, &master_key_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

uint8_t *user_context_bytes = NULL;
size_t user_context_size = 0;

if (read_line_binary(stdin, &user_context_bytes, &user_context_size))
if (read_line_binary(input, &user_context_bytes, &user_context_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

uint8_t *message_bytes = NULL;
size_t message_size = 0;

if (read_line_binary(stdin, &message_bytes, &message_size))
if (read_line_binary(input, &message_bytes, &message_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

fclose(input);

/*
* Try decrypting it.
*/
Expand All @@ -70,12 +89,15 @@ int main(void)

if (err != THEMIS_BUFFER_TOO_SMALL)
{
fprintf(stderr, "failed to determine decrypted message size: %d\n", err);
return 2;
}

decrypted_bytes = malloc(decrypted_size);
if (!decrypted_bytes)
{
fprintf(stderr, "failed to allocate memory for decrypted message (%zu bytes)\n",
decrypted_size);
return 2;
}

Expand All @@ -87,6 +109,7 @@ int main(void)

if (err != THEMIS_SUCCESS)
{
fprintf(stderr, "failed to decrypt message: %d\n", err);
return 2;
}

Expand Down
38 changes: 34 additions & 4 deletions tools/afl/src/scell_seal_roundtrip.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* limitations under the License.
*/

#include <errno.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
Expand All @@ -23,38 +24,56 @@

#include "readline.h"

int main(void)
int main(int argc, char **argv)
{
themis_status_t err = THEMIS_SUCCESS;

/*
* Read test data.
*/

if (argc != 2)
{
fprintf(stderr, "usage:\n\t%s <input-file>\n", argv[0]);
return 1;
}

FILE* input = fopen(argv[1], "rb");
if (!input)
{
fprintf(stderr, "failed to open %s: %s\n", argv[1], strerror(errno));
return 1;
}

uint8_t *master_key_bytes = NULL;
size_t master_key_size = 0;

if (read_line_binary(stdin, &master_key_bytes, &master_key_size))
if (read_line_binary(input, &master_key_bytes, &master_key_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

uint8_t *user_context_bytes = NULL;
size_t user_context_size = 0;

if (read_line_binary(stdin, &user_context_bytes, &user_context_size))
if (read_line_binary(input, &user_context_bytes, &user_context_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

uint8_t *message_bytes = NULL;
size_t message_size = 0;

if (read_line_binary(stdin, &message_bytes, &message_size))
if (read_line_binary(input, &message_bytes, &message_size))
{
fprintf(stderr, "failed to read %s: %s\n", argv[1], strerror(errno));
return 1;
}

fclose(input);

/*
* Try encrypting the message.
*/
Expand All @@ -70,12 +89,15 @@ int main(void)

if (err != THEMIS_BUFFER_TOO_SMALL)
{
fprintf(stderr, "failed to determine encrypted message size: %d\n", err);
return 2;
}

encrypted_bytes = malloc(encrypted_size);
if (!encrypted_bytes)
{
fprintf(stderr, "failed to allocate memory for encrypted message (%zu bytes)\n",
encrypted_size);
return 2;
}

Expand All @@ -87,6 +109,7 @@ int main(void)

if (err != THEMIS_SUCCESS)
{
fprintf(stderr, "failed to encrypt message: %d\n", err);
return 2;
}

Expand All @@ -105,12 +128,15 @@ int main(void)

if (err != THEMIS_BUFFER_TOO_SMALL)
{
fprintf(stderr, "failed to determine decrypted message size: %d\n", err);
return 3;
}

decrypted_bytes = malloc(decrypted_size);
if (!decrypted_bytes)
{
fprintf(stderr, "failed to allocate memory for decrypted message (%zu bytes)\n",
decrypted_size);
return 3;
}

Expand All @@ -122,6 +148,7 @@ int main(void)

if (err != THEMIS_SUCCESS)
{
fprintf(stderr, "failed to decrypt message: %d\n", err);
return 3;
}

Expand All @@ -131,10 +158,13 @@ int main(void)

if (decrypted_size != message_size)
{
fprintf(stderr, "message length does not match: actual %zu, expected %zu\n",
decrypted_size, message_size);
abort();
}
if (memcmp(message_bytes, decrypted_bytes, message_size) != 0)
{
fprintf(stderr, "message content does not match\n");
abort();
}

Expand Down