Feature: support custom 'defines'

Some libraries or packages have custom defines, such as the firewall _en_firewall_debug_.

Provide simple documentation of the defines, in the data/build/defines file.
Provide build settings values for specifying these custom defines.
Provide parameter for manually overriding defines.

Some path settings have been renamed to avoid confusion (such as '--c_path' is now '--path_c').

Enable _en_firewall_debug_ by default.

Cleanup: remove 'DEBUG: ' from debug output

Update: add build_libraries_fll build setting

Add a new parameter to make it easier to switch between individual compilation, level compilation, and monolithic compilation.
This parameter will only be used for fll-specific libraries.

For programs (aka: "level 3") commented out examples for linking against level-based and monolithic are provided.
The configurations can then be easily swapped out by a couple of simple sed statements, such as:
  - sed -i -e 's|^build_libraries_fll\>|#&|g' data/build/settings
  - sed -i -e 's|^#build_libraries_fll-level\>|build_libraries_fll|g' data/build/settings

The above example will switch to the level based compiling, while disabling the individual compiling.

The level based compiling compiles each of the levels 0, 1, and 2 as a single library for each level, resulting in libraries such as:
  - libfll_0-0.5.0.so
  - libfll_1-0.5.0.so
  - libfll_2-0.5.0.so

The monolithic based compiling compiles all of the levels 0, 1, and 2 as a single library, resulting in libraries such as:
  - libfll-0.5.0.so

The standard names of individual, level, and monolithic do not overlap by default and can therefoe be installed side-by-side.

Feature: work directory support

Work Directory provides an easier way for developers to compile and test a particular set of FLL libraries and programs without conflicting with the host system.

If the host system has some version of the FLL project installed, the versions in the work directory will be used instead of the system directories.

Specifying the work directory is done via the '-w' or '--work_directory' commands.

To better achieve this functionality in the install.sh script, four new additional parameters were created:
- --libraries-static
- --libraries-shared
- --programs-static
- --programs-shared

These provide additional relative or absolute paths for installing the programs and libraries into.
The relative paths for --libraries-static and --libraries-shared is the library directory (which can be specified via --libdir).
The relative paths for --programs-static and --programs-shared is the program directory (which can be specified via --bindir).

Bugfix: install script destination parameters not being respected

I used the wrong name in the grab_next variable when designating to grab the next includedir and libdir.
There is also a mistake where I was copying the destination_prefix onto itself.

Update: always return 1 on failure

There were some cases where exit is not being called and other cases where exit 0 is being called.
Make sure that exit 1 is called on error so that this script can then be scriptable.

Bugfix: level-specifc compile settings should compile against level-specific

Security: set default policy to DROP after deleting chains

Performing numerous syscalls can by slow.
During this time, if the default behavior is open, then unwanted packets may make it through.
By dropping by default, these packets will not go through.

Bugfix: type sizes autodetection is not reporting proper sizes

Expected sizes are not being returned.
Rewrite the logic to get casting to the highest value to work as desired.

Bugfix: bash/linux does not support setting high bits on return codes

These bits are generally reserved for process-specific behavior.
Explicitly return 0 for success and 1 for failure.
The firewall program already does this.

The return codes from the main functions of each project will continue to utilize all of the bits as designed.
This will allow for projects that link to the library to get the actual return codes while simultaneously being compatible with Linux and Bash.

Later versions may provide alternative ways to get the error code from within the shell.
For example, if a specific return code environment variable is set, then the program could populate that environment variable on exit (clearing it on start).

Update: add basic featureless settings specifications documentation

This was originally defined online, but I had lost the data at some point.
The internet archive didn't cache the page and the data lost happened during the time I was changing the website.

The specifications were simple enough to be rewritten, but I have done so in haste.
Some of the specifications will be documented at a later date.

I do not remember what advanced reverse mapping was intended to be, so I replaced it with the custom json-like specification.
The goal of the json-like specification is to write it such that it is still valid json (minus any comments).
It is currently added to preserve the idea but there are no immediate plans to implement this specification.

Update: replace advanced reverse mapping with simple json

Cleanup: fix comments and remove commented out memset

According to the standards that I have read, calloc() guarantees zero'd memory, so memset is not needed.
It so happens that the memset was commented out already, so just remove it.

There are some memset related comments that incorrectly use the word 'bool' when the word 'char' should be used.

Update: set micro version to 3, from 2

Update: add the firewall settings files to the 'build_sources_settings' part of the build settings file

Update: Add additional options, fix minor problems, and other  miscellaneous fixes in regards to generate.sh and package.sh scripts

Add functionality provided in install.sh, such as configure based system compatible options: --enable-statuc, --disable-static, --enable-shared, and --disable-shared.

Fix some typos (such as failire which should instead be failure).
Tweak highlight colors used.

Use a separate "operation_failure" variable instead of recycling "operation" for parameter operation problems.

Add -S/--path_s parameter option for specifying a custom settings path.

If paths have a leading slash (/), remove duplicate slashes (such as "///bin/" -> "/bin/").

Make sure the new install.sh script gets added by the package.sh script.

The variable "sources_settings" is using the wrong source path (which was "path_c").
Instead, use the newly added "path_s".

Feature: add install.sh helper script

Provide a very basic install helper script for systems (or users) that do not have or do not want to use their package system to install the compiled files.

This is only intended to help someone install.
It is still recommended that a distribution or packager should povide their own tools to perform the installation.

Cleanup: use 'FILTER' instead of 'PORTS'

Cleanup: make sure 'iptables' appears in error message 'Failed to perform requested iptables operation'

Update: fix firewall utility and utilize recently added functionality

There were a few logic flaws in regards to the processing and memory management.
Switch to new logic where f_new_* and f_clear_* is utilized.
Update accodingly to the fll_execute changes.

Update the default configuration files.

Update the debugging code to work as expected.

Replace string cuntions with memory functions, such as replacing strncat with memcpy.

Add some new helper macros.

Delete all custom chains when rewriting rules to prevent problems.
Iptables unfortunately does not provide a way to check and see if a chain already exists.

Update: disable BUG_strnlen by default

This bug might actually be a bug related to uClibc.
Just disable it by default for now.
Future versions may remove this workaound entirely.

Cleanup: add space

Update: use memcpy instead of strncat

Update: add an f_standard_debug output similar to f_standard_warning

Update: rewrite fll_execute, ensuring f_eol are properly added (and auto-add progam name where possible)

Previously, the f_eol was added but it assumed that there was actual room at the end of the allocated buffer to do so.
This now explicilty allocates a new buffer with room for the terminating f_eol.

The progam name is already provided, so do not require it to be added to the arguments (auto-add it).

Update: make sure f_new_* calls exist and add f_clear_* calls

Bugfix: string lengths now use signed integers

Update: relocate the shared and static build paths to before the library arguments

Bugfix: firewall show command operating as lock

The debug parameters is conditionally enabled/disabled but the enum is not.
Make the enum conditionally enable/disable the debug option to prevent the wrong id from being used when debug is disabled.

Fix the alignment of the debug message.

Conditionally enable/disable displaying the debug in the help.

Bugfix: add missing closing parenthesis

Update: version to 0.4.3

Bugfix: project compiled libraries are not being found

This is the result of an oversight when I converted the libraries directory to have static and shared into subdirectories.
The explicit link path was not updated accordingly.

Feature: add package generation helper scrript

There are four intended package design modes:
1) individual - each package is separated into their own individual directory and version.
2) level - Each of the three levels (level 0, level 1, and level 2) are put into their own directory and version.
3) monolothic - All three levels (level 0, level 1, and level 2) are put into a single directory and version.

Monolithic is not currently implemented due to design limitations in the generate.sh script and build settings files.

Compression is not performed.

Cleanup: re-organize object file generation into separate directory

The object files should be added in an 'objects/' directory instead of in 'libraray/static/' directory.

Security: use signed integers for string lengths and array lenghts by default

Standard functions, such as strnlen(), appear to operate on signed integers instead of unsigned.
Not being able to handle unsigned integers provides unknown behavior that could lead to potential security vulnerabilities.
Future versions of this project will likely need to abandon these methods for more flexible alternatives.

Example problem:
  sources/c/console.c:36:23: warning: 'strnlen' specified bound 18446744073709551615 exceeds maximum object size 9223372036854775807 [-Wstringop-overflow=]
     36 |       string_length = strnlen(argv[location], f_console_max_size);

That is 2^63 instead of the expected 2^64.

The array lengths were converted to signed as well.

Bugfix: add missing includes

Cleanup: add missing build_static default setting and remove duplicates

Update: version to 0.4.3

Bugfix: variables not being stored in array

Do not directly use string in bash array arguments.
More recent versions of bash do not handle this as expected.
Move explicit string to a variable and then use that variable to access the array.

Update: add support for separate build_static setting

This allows for building both shared and static libraries and programs.

Update: use firewall_default_allocation_step, +1 was being used and should have been +firewall_default_allocation_step

Update: change default rules for icmp traffic and cleanup some comments

I learned a little bit more about icmp and what is and is not deprecated.
Block certain icmp ports by default.

Shorten the file by removing unnecessary comments.

Update: do not resize strings when length = 0, instead just updated used

I was working on this before I moved.
I am not sure if there is more too this that needs to be done, but for now I will push this.

Bugfix: direction option was confusing because it was mixed with chains

- Separate direction command into two separate commands: direction, and chain.
- The chain command mimics iptables chains and is automatically populated by the custom lists (aka: custom chains).
- When direction is set to something other than none, then the active ethernet device is used.
- Code cleanup and changes were performed while working on this.
- Added basic support for debugging, define _en_firewall_debug_ to enable custom debugging parameter.

Update: add debug as a standard console parameter

Update: oops! don't block unicasts by default

Whoops, I overlooked that unicast was the name for the normal, expected, behavior of standard point to point network connections.

Update: improve the contents firewall settings files

- Add more information to the example firewall settings.
- Improve/fix dhcp client/server rules
- Block/Blackhole unicasts, multicasts, and broadcasts.
- Add some examples rules on conntrack and some security rules.

Bugfix: reverse order of library links

It seems I got the order backwards.
I was using -lc and all the lowest level libraries on the left of the libraries that depend on it.
This caused unobvious linkage errors down the road.
Reversing the order prevented the problem and allowed for static libraries to link.

It is possible the order issue is with ar and not with gcc.

Bugfix: remove more cases where build_alt variables where still being used

Bugfix: fix order of library linkage for firewall build settings

The ar command is sensitive to the order in which libraries are added.
Prior to this change, building a static library could have dependencies used before they are defined due to the order in which libraries were added.
Change the order so that libraries are to the right of their dependencies in the command line argument order

Bugfix: fix order of library linkage

The ar command is sensitive to the order in which libraries are added.
Prior to this change, building a static library could have dependencies used before they are defined due to the order in which libraries were added.
Change the order so that libraries are to the right of their dependencies in the command line argument order.

Bugfix: revert compiler workaround 5bdaa0b, place arguments after source

The problem turns out to be that, for gcc at the very least, linker options such as -lc are not properly passed to the linker when it is before the source files.
Using the examples:
  1) gcc -lc main.c
  2) gcc main.c -lc

In case of #1, the -lc is not passed to the linker.
In case of #2, the -lc is passed to the linker.

All arguments are now being moved after the source parts.

see: 5bdaa0b Workaround: compilers on some systems seem to be sensitive to the order of arguments
see: http://gcc.gnu.org/onlinedocs/gcc/Link-Options.html

Update: f_error changes and more signals

- Added more signal commands.
- Added more signal codes for up to 64 signals.
- Replaced f_error_unmask with f_error_set_fine to be more consistent with the other f_error_set_* names.
- The signal bit is intended to be both the error and warning bit set so it is mathematically the same as the mask bit.
- Change f_none starting point to 197 to handle all possible 64 signals.

Cleanup: explicitly initialize f_false enumerator to 0.

Update: add signal code support to f_errors and move error code starting point to 166

Signals are used as the high order bits in a process that exits, which is where I provide error and similar return codes.
For this reason I am adding wrappers to the x86 signal codes in f_errors instead of a separate custom project such as the non-existant f_signals.

It looks like bash mixes the exit codes and signals into the numbers 129 to 165, so start with 166 as well.

Update: uncomment pipe detection code in return_code and fss_return_code

Not sure why this was disabled, perhaps it was not implemented?
At least, enable the variable.

Feature: add support for -p, --project in generate.sh

This adds support for defining a custom name for the use of preparing and building a project.
The files will be called .built-$project and .prepare-$project.
This allows for building multiple projects in the same directory path back to back.

Cleanup: remove unused parameter 'settings_path'

Update: add level's 0, 1, and 2 settings file to build a single library per level

Update: define f_extern as extern

This should allow for mass changing or mass removing f_extern via a simple custom #define or a command line parameter such as -Df_extern= .

Feature: add support for defining the linker program via build_linker= setting

Bugfix: fix missing dependencies

Cleanup: correct the documentation on the file's level

Bugfix: add missing required library link dependencies

It seems I got away with forgetting some important libraries that were required by some libraries.
This makes me wonder if this is the cause of the bug that forced me to create the build_alt option.

Bugfix: programs incorrectly reporting version

I noticed, unfortunately after the release and not before, that the proper version number was not being reported.
This seems to have been an oversight.

To reduce the chances of this happening, I decided to make the next version number be the default.
I will make a release after a month or two fixing this.

Workaround: compilers on some systems seem to be sensitive to the order of arguments

As far as I can tell, some systems (in my case, it was on linuxmint, either debian or ubuntu) the compiler interprets the following differently:
  1) gcc -lc main.c
  2) gcc main.c -lc

The should be the same, but they are not for some compilers.

This is also not as obvious, some programs or libraries compile while others do not.

In my case, I ran the entire compilation of the f_* fl_* and fll_* libraries using the approach from (1).
Everything compiled and worked, up until I tried to compile my firewall program.
It complained that firewall_main was not found, despite all of the libraries in the path being valid.

I had to recompile the entire f_* fl_* and fll_* libraries using (2) for the firewall program to compile.
No functional changes were made, simply the order of compile arguments.

Therefore, I have implemented an alternative version of the build command, called build_alt.
This should be used if you are using a system where (2) is required over (1).

Bugfix: fix mistake in variable usage within generate.sh

The $sources variable has invalid bash syntax.

Release: FLL 0.4.0

On second thought, 0.3.1 does not need to be released because there is no further development going on in the 0.3.x branch.
Instead, make a stable release (0.4.0).

Release: FLL 0.3.1

Update: remove unavailable script function references

The install and uninstall functions were referenced but are no longer defined.
Just remove their references.

Bugfix: free allocated memory when exiting on fork error

Bugfix: properly initialize name_size string_length

Update: add readme file for generate.sh

Update: add dependencies files

Update: Report total number of content parts when doing a total

This is uneeded for basic and basic list, but extended supports multiple content parts.
When -t is passed while doing a selection using -c, report the total number of content parts instead of the total number found.

Bugfix: correct mistakes in firewall settings files

The files were not entirely synced with my local copies and contained invalid configurations.

Bugfix: fl_execute is now fll_execute

At some point fl_execute and level_1/execute.h where moved to level 2: fll_execute and level_2/execute.h.
This corrects files that did not get updated to reflect this change.

Update: use +v and ++version instead of -v and --version

Use of -v and --version is less common than -h and --help.
Instead, use +v and ++version to free up -v for other purposes like --verbose.

Bugfix: ipv6 icmp is different than ipv4 icmp, adjust rules accordingly

The ipv6 in iptables uses a separate command called icmpv6, with the parameter called icmpv6-type.
Adjust the default settings files to use ipv4 icmp only with iptables and ipv6 icmp only with ip6tables.

This also updates the icmp types for ipv6, adding comments on what each type is.

Bugfix: Fix usage of rule_contents for protocol none option

The if condition that is checking for the existing of the protocol option 'none' was improperly setup.
It was using the rule_objects instead of the rule_contents and therefore would never validate.

Feature: add support for ipv6 firewall via new 'tool' option

This adds the 'tool' option that can assign one of the following values:
- iptables
- ip6tables
- ip46tables

This adds support for ipv6 firewalling.
The default firewall rules enables iptables and ip6tables via the option called ip46tables.

Also, future versions will include support for the tool 'ipset'.

Bugfix: fix build and install data settings file

The settings should be for fll_colors and not fll_print.

Cleanup: move color context structure from level 2 to level 1

Nothing in it depends on level 2.
Move it to level 1, making it available to all level 2 projects.
This renames the structure from fll_color_context to fl_color_context.
Appropriate initializers and memory related macros are renamed accordingly.

Bugfix: fix f_error_is_not_error logic

The logic is wrong.
Just use the error bit instead.
Remove f_error_bit_not_error as it is not needed.

Cleanup: rename/move f_output to f_print

Be consinstent with the project+names wherever possible.
In this case, it is very much possible.
The functions area already called f_print*, so change the name of the project to f_print.

Update: remove *_initialize for specific types

Data types that are numeric, non-pointer, and non-structure should not need an *_initializer macros.
It has been decided for simplicity purposes that these will be left alone.

All other data types that are either non-numeric, pointers, or structures will continue to require *_initialize macros.

Cleanup: remove stale todo notes

These notes were never meant to be committed.
What they represented is already implemented.

Update: return f_unknown at end of f_is_digit

If for some reason the end of the function is reached, f_unknown is returned.
This should be impossible and if compilers give an error, then that line can be removed.

Update: redesign error codes

This is a major rewrite of the error code system.

Previously, the error system did the following:
- used an unsigned short data type
- allowed for all 16 bits to be used
- because it was unsigned short, different architectures might have different size.
- it is rather inefficient and ugly to check for errors when there may be as many as 30 different error codes to compare against.

The new error system does the following:
- enforce exactly 16-bit unsigned integer by using uint16_t.
- reserves the first two high order bits in the following manner:
  - bit 1 = error bit (1000 0000 0000 0000)
  - bit 2 = warning bit (0100 0000 0000 0000)
  - (note setting both bit 1 and bit 2 is unsupported)
- provide a series of macros to quickly detect and manage the new bits
- limits the total available number of error codes to 14-bits instead of 16-bits

The advantage of the new system is that what the status code is can be detected in one or two conditionals (using bitwise operations).
This should speed up performance and make the code easier to read.

Update: add the new default/example firewall setting files

I forgot to add this with one of the previous commits.
This is the rewrite of the setting rules using custom chains.
This also utilizes the newly added protocol support.

Feature: add support for 'protocol' option

The protocol option adds support for mass adding things like '-p tcp' in front of every rule.
This reduces repetition of the -p * commands.

The 'protocol' option accepts any single parameter or the reserved parameter 'none'.
Using 'none' will turn off the protocol option.
Other than 'none', this poses no restrictions on what the protocol may be.
Instead, that is left to iptables.

Update: rewrite firewall, adding support for custom chains

This is a major redesign of the firewall program.
Iptables chains are now supported automatically.
Each new basic list is itself a chain.
Reserved words not allowed for custom chains are:
- main
- stop
- lock

The 'main' chain signifies use of the default iptables chain.

The layout and structure of the files have been rewritten to utilize chains.
The default-firewall file has been removed and replaced with the following files:
- firewall-first
- firewall-last
- firewall-other

The newly written rules defines default firewall rules and chains such that there the following self-explanatory chains:
- input-tcp
- input-udp
- input-icmp
- output-tcp
- output-udp
- output-firewall

In addition to the above changes, the base functionality has been broken up into smaller functions to improve code quality.

Update: add support for array_length arrays

Because this uses memory operations it was moved to a separate file called types_arrays.h
This adds a dependency on f_memory.
While the dependency is circular, f_types will never provide source files.
Therefore chicken and the egg issues should not be a problem (f_types is always installed before f_memory).

Bugfix: fix invalid f_string_lengths initializer

This should initialize to 0 and not the f_string_length_initializer because it is a pointer.

Update: add file position reset macro

Define a macro because creating a function is just overkill for this.
This macro should save a few lines of code when reseting the file position.

Bugfix: reset position on back to back lists

If two lists are back to back such that one does not have content, then make sure that the position resets to the start.
If this does not happen, then the next object will be skipped.

Update: remove used vs size parameter checking

Remove this so that non-dynamic strings can be placed in a dynamic string data type.
In such cases, the dynamic string has a used but not a size.
This means allocations should not be performed on the string.

Cleanup: Move private functions into its own source and header files

It has become painfully apparent that much of the firewall main function needs to be broken down into smaller functions for managability and readability purposes.
The first step in doing such is to create a privte header and source files and move all internal functions there.
Everything in the private-* files are intended to never be exposed in the library.
Its only purpose is to make programming large projects more managable and readable.
As such, none of the functions should ever be considered part of the libraries/programs api.

Bugfix: use proper if then logic in firewall

Some of the if then else statements where not properly nested.
As a result, valid list objects got skipped.

Cleanup: remove stale TODO comment in firewall

The TODO is already done.