Skip to content

Commit

Permalink
secilc: Create the new program called secil2tree to write out CIL AST
Browse files Browse the repository at this point in the history
secil2tree is the SELinux CIL AST writer. It calls the cil functions
cil_write_parse_ast(), cil_write_build_ast(), or cil_write_resolve_ast()
to write out the parse tree, the CIL AST after the build phase, or the
CIL AST after the resolve phase.

Signed-off-by: James Carter <jwcart2@gmail.com>
  • Loading branch information
jwcart2 authored and fishilico committed Apr 21, 2021
1 parent 86ec04c commit d0a07a7
Show file tree
Hide file tree
Showing 4 changed files with 307 additions and 2 deletions.
2 changes: 2 additions & 0 deletions secilc/.gitignore
Expand Up @@ -2,6 +2,8 @@ secilc
secilc.8
secil2conf
secil2conf.8
secil2tree
secil2tree.8
policy.*
file_contexts
docs/html
Expand Down
20 changes: 18 additions & 2 deletions secilc/Makefile
Expand Up @@ -10,8 +10,13 @@ SECIL2CONF = secil2conf
SECIL2CONF_SRCS := secil2conf.c
SECIL2CONF_OBJS := $(patsubst %.c,%.o,$(SECIL2CONF_SRCS))

SECIL2TREE = secil2tree
SECIL2TREE_SRCS := secil2tree.c
SECIL2TREE_OBJS := $(patsubst %.c,%.o,$(SECIL2TREE_SRCS))

SECILC_MANPAGE = secilc.8
SECIL2CONF_MANPAGE = secil2conf.8
SECIL2TREE_MANPAGE = secil2tree.8
XMLTO = xmlto
DIFF = diff

Expand All @@ -23,7 +28,7 @@ CFLAGS ?= -Wall -Wshadow -Wextra -Wundef -Wmissing-format-attribute -Wcast-align
override CFLAGS += -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64
override LDLIBS += -lsepol

all: $(SECILC) $(SECIL2CONF) man
all: $(SECILC) $(SECIL2CONF) $(SECIL2TREE) man

$(SECILC): $(SECILC_OBJS)
$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LDLIBS)
Expand All @@ -37,21 +42,29 @@ test: $(SECILC)
$(SECIL2CONF): $(SECIL2CONF_OBJS)
$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LDLIBS)

man: $(SECILC_MANPAGE) $(SECIL2CONF_MANPAGE)
$(SECIL2TREE): $(SECIL2TREE_OBJS)
$(CC) $(CFLAGS) $(LDFLAGS) -o $@ $^ $(LDLIBS)

man: $(SECILC_MANPAGE) $(SECIL2CONF_MANPAGE) $(SECIL2TREE_MANPAGE)

$(SECILC_MANPAGE): $(SECILC_MANPAGE).xml
$(XMLTO) man $(SECILC_MANPAGE).xml

$(SECIL2CONF_MANPAGE): $(SECIL2CONF_MANPAGE).xml
$(XMLTO) man $(SECIL2CONF_MANPAGE).xml

$(SECIL2TREE_MANPAGE): $(SECIL2TREE_MANPAGE).xml
$(XMLTO) man $(SECIL2TREE_MANPAGE).xml

install: all man
-mkdir -p $(DESTDIR)$(BINDIR)
-mkdir -p $(DESTDIR)$(MANDIR)/man8
install -m 755 $(SECILC) $(DESTDIR)$(BINDIR)
install -m 755 $(SECIL2CONF) $(DESTDIR)$(BINDIR)
install -m 755 $(SECIL2TREE) $(DESTDIR)$(BINDIR)
install -m 644 $(SECILC_MANPAGE) $(DESTDIR)$(MANDIR)/man8
install -m 644 $(SECIL2CONF_MANPAGE) $(DESTDIR)$(MANDIR)/man8
install -m 644 $(SECIL2TREE_MANPAGE) $(DESTDIR)$(MANDIR)/man8

doc:
$(MAKE) -C docs
Expand All @@ -61,10 +74,13 @@ clean:
rm -f $(SECILC_OBJS)
rm -f $(SECIL2CONF)
rm -f $(SECIL2CONF_OBJS)
rm -f $(SECIL2TREE)
rm -f $(SECIL2TREE_OBJS)
rm -f policy.*
rm -f file_contexts
rm -f $(SECILC_MANPAGE)
rm -f $(SECIL2CONF_MANPAGE)
rm -f $(SECIL2TREE_MANPAGE)
rm -f opt-actual.cil
rm -f opt-actual.bin
$(MAKE) -C docs clean
Expand Down
81 changes: 81 additions & 0 deletions secilc/secil2tree.8.xml
@@ -0,0 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry>
<refentryinfo>
<author>
<firstname>James</firstname><surname>Carter</surname><contrib></contrib>
</author>
</refentryinfo>

<refmeta>
<refentrytitle>SECIL2TREE</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="date">05 April 2021</refmiscinfo>
<refmiscinfo class="source">secil2tree</refmiscinfo>
<refmiscinfo class="manual">SELinux CIL AST Writer</refmiscinfo>
</refmeta>
<refnamediv id="name">
<refname>secil2tree</refname>
<refpurpose>invoke the SELinux Common Intermediate Language (CIL) AST Writer </refpurpose>
</refnamediv>

<refsynopsisdiv id="synopsis">
<cmdsynopsis>
<command>secil2tree</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1 id="description"><title>DESCRIPTION</title>
<para><emphasis role="italic">secil2tree</emphasis> invokes the CIL AST Writer with the specified <emphasis role="italic">argument</emphasis>s.</para>
</refsect1>

<refsect1 id="options"><title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>-o, --output=&lt;file></option></term>
<listitem><para>Write AST to <emphasis role="italic">file</emphasis> (default: stdout)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-P, --preserve-tunables</option></term>
<listitem><para>Treat tunables as booleans.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-A, --ast-phase=&lt;phase></option></term>
<listitem><para>Write AST of phase <emphasis role="italic">phase</emphasis>. Must be <emphasis role="bold">parse</emphasis>, <emphasis role="bold">build</emphasis>, or <emphasis role="bold">resolve</emphasis>. (default: <emphasis role="bold">resolve</emphasis>)</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-v, --verbose</option></term>
<listitem><para>Increment verbosity level.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-h, --help</option></term>
<listitem><para>Display usage information.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 id="see_also"><title>SEE ALSO</title>
<para>
<simplelist type="inline">
<member><citerefentry>
<refentrytitle>secilc</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry></member>
<member><citerefentry>
<refentrytitle>secil2conf</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry></member>
</simplelist>
</para>
<para>HTML documentation describing the CIL language statements is available starting with <emphasis role="italic">docs/html/index.html</emphasis>.</para>
<para>PDF documentation describing the CIL language statements is available at: <emphasis role="italic">docs/pdf/CIL_Reference_Guide.pdf</emphasis>.</para>
</refsect1>
</refentry>
206 changes: 206 additions & 0 deletions secilc/secil2tree.c
@@ -0,0 +1,206 @@
/*
* Copyright 2011 Tresys Technology, LLC. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY TRESYS TECHNOLOGY, LLC ``AS IS'' AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL TRESYS TECHNOLOGY, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those
* of the authors and should not be interpreted as representing official policies,
* either expressed or implied, of Tresys Technology, LLC.
*/

#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <getopt.h>
#include <sys/stat.h>

#ifdef ANDROID
#include <cil/cil.h>
#else
#include <sepol/cil/cil.h>
#endif
#include <sepol/policydb.h>

enum write_ast_phase {
WRITE_AST_PHASE_PARSE = 0,
WRITE_AST_PHASE_BUILD,
WRITE_AST_PHASE_RESOLVE,
};

static __attribute__((__noreturn__)) void usage(const char *prog)
{
printf("Usage: %s [OPTION]... FILE...\n", prog);
printf("\n");
printf("Options:\n");
printf(" -o, --output=<file> write AST to <file>. (default: stdout)\n");
printf(" -P, --preserve-tunables treat tunables as booleans\n");
printf(" -A, --ast-phase=<phase> write AST of phase <phase>. Phase must be parse, \n");
printf(" build, or resolve. (default: resolve)\n");
printf(" -v, --verbose increment verbosity level\n");
printf(" -h, --help display usage information\n");
exit(1);
}

int main(int argc, char *argv[])
{
int rc = SEPOL_ERR;
FILE *file = NULL;
char *buffer = NULL;
struct stat filedata;
uint32_t file_size;
char *output = NULL;
struct cil_db *db = NULL;
int preserve_tunables = 0;
enum write_ast_phase write_ast = WRITE_AST_PHASE_RESOLVE;
int opt_char;
int opt_index = 0;
enum cil_log_level log_level = CIL_ERR;
static struct option long_opts[] = {
{"help", no_argument, 0, 'h'},
{"verbose", no_argument, 0, 'v'},
{"preserve-tunables", no_argument, 0, 'P'},
{"output", required_argument, 0, 'o'},
{"ast-phase", required_argument, 0, 'A'},
{0, 0, 0, 0}
};
int i;

while (1) {
opt_char = getopt_long(argc, argv, "o:hvPA:", long_opts, &opt_index);
if (opt_char == -1) {
break;
}
switch (opt_char) {
case 'v':
log_level++;
break;
case 'P':
preserve_tunables = 1;
break;
case 'o':
output = strdup(optarg);
break;
case 'A':
if (!strcasecmp(optarg, "parse")) {
write_ast = WRITE_AST_PHASE_PARSE;
} else if (!strcasecmp(optarg, "build")) {
write_ast = WRITE_AST_PHASE_BUILD;
} else if (!strcasecmp(optarg, "resolve")) {
write_ast = WRITE_AST_PHASE_RESOLVE;
} else {
fprintf(stderr, "Invalid AST phase: %s\n", optarg);
usage(argv[0]);
}
break;
case 'h':
usage(argv[0]);
case '?':
break;
default:
fprintf(stderr, "Unsupported option: %s\n", optarg);
usage(argv[0]);
}
}

if (optind >= argc) {
fprintf(stderr, "No cil files specified\n");
usage(argv[0]);
}

cil_set_log_level(log_level);

cil_db_init(&db);
cil_set_preserve_tunables(db, preserve_tunables);
cil_set_attrs_expand_generated(db, 0);
cil_set_attrs_expand_size(db, 0);

for (i = optind; i < argc; i++) {
file = fopen(argv[i], "r");
if (!file) {
fprintf(stderr, "Could not open file: %s\n", argv[i]);
rc = SEPOL_ERR;
goto exit;
}
rc = stat(argv[i], &filedata);
if (rc == -1) {
fprintf(stderr, "Could not stat file: %s\n", argv[i]);
goto exit;
}
file_size = filedata.st_size;

buffer = malloc(file_size);
rc = fread(buffer, file_size, 1, file);
if (rc != 1) {
fprintf(stderr, "Failure reading file: %s\n", argv[i]);
goto exit;
}
fclose(file);
file = NULL;

rc = cil_add_file(db, argv[i], buffer, file_size);
if (rc != SEPOL_OK) {
fprintf(stderr, "Failure adding %s\n", argv[i]);
goto exit;
}

free(buffer);
buffer = NULL;
}

if (output == NULL) {
file = stdout;
} else {
file = fopen(output, "w");
if (file == NULL) {
fprintf(stderr, "Failure opening file %s for writing\n", output);
rc = SEPOL_ERR;
goto exit;
}
}

switch (write_ast) {
case WRITE_AST_PHASE_PARSE:
rc = cil_write_parse_ast(file, db);
break;
case WRITE_AST_PHASE_BUILD:
rc = cil_write_build_ast(file, db);
break;
case WRITE_AST_PHASE_RESOLVE:
rc = cil_write_resolve_ast(file, db);
break;
}

if (rc != SEPOL_OK) {
fprintf(stderr, "Failed to write AST\n");
goto exit;
}

exit:
if (file != NULL && file != stdin) {
fclose(file);
}
free(buffer);
free(output);
cil_db_destroy(&db);
return rc;
}

0 comments on commit d0a07a7

Please sign in to comment.