Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Holcomb committed Aug 22, 2022
0 parents commit 35a5153
Show file tree
Hide file tree
Showing 43 changed files with 17,453 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*/target
/target
Cargo.lock
*.DS_Store
*.logarchive
tests.zip
29 changes: 29 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# How to build
1. Download and install Rust from https://www.rust-lang.org/
* Windows users will need Windows C++ build tools https://visualstudio.microsoft.com/visual-cpp-build-tools/
* Select `Desktop development with C++`
* This is a Rust requirement for Windows
2. Git clone the repo
3. Navigate to cloned repo.
4. Execute `cargo build` to build debug library. `cargo build --release` to build release version
* Navigate to examples directory and run `cargo build --release` to build the example files
* `unifiedlog_parser` and `unifiedlog_parser_json` can parse a live macOS system if no arguements are presented. Both can also parse a `logarchive` if passed as an arguement

# Running test suite
1. Follow steps above
2. Download `tests.zip` from Github releases
3. Copy/move `tests.zip` to clone repo
4. Decompress `tests.zip`
5. Execute `cargo test --release` to run tests
* You can also just use `cargo test` to run tests but it will be slower


# Running benchmarks
1. Download `tests.zip` from Github releases
2. Copy/move `tests.zip` to clone repo
3. Decompress `tests.zip`
4. Run `cargo bench`
or
4. Install criterion, `cargo install cargo-criterion`
5. Run `cargo criterion`

35 changes: 35 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[package]
name = "macos-unifiedlogs"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
nom = "7.1.0"
serde_json = "1.0.79"
serde = {version="1.0.136", features = ["derive"]}
log = "0.4.14"
lz4_flex = "0.9.2"
byteorder = "1.4.3"
plist = "1.3.1"
regex = "1.5.5"
base64 = "0.13.0"

[dev-dependencies]
simplelog = "0.12.0"
csv = "1.1.6"
chrono = "0.4.19"
criterion = "0.3.5"

[[bench]]
name = "high_sierra_benchmark"
harness = false

[[bench]]
name = "big_sur_benchmark"
harness = false

[[bench]]
name = "monterey_benchmark"
harness = false
49 changes: 49 additions & 0 deletions LIBRARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Parsing the log data
There two (2) ways to parse log data using `macos-unifiedlogs`
1. Running on a live system
2. Providing a custom directory

Once you have added the library to `Cargo.toml` five (5) functions are used to parse the log data.
## Live System
1. `collect_strings_system()` Returns a `Result<Vec<UUIDText>, ParserError>` which is a vector structure containing UUID data
2. `collect_shared_strings_system()` Returns a `Result<Vec<SharedCacheStrings>, ParserError>` which is a vector structure containing UUID cached data
3. `collect_timesync_system()` Returns a `Result<Vec<TimesyncBoot>, ParserError>` which is a vector structure containing timesync data

The above three (3) functions should be called first and load the results in memory. This will allow for fast lookups when building the logs. The UUID, UUID cache, and timesync files are very small and should not be impactful on memory usage.

After getting the UUID, UUID cache, and timesync data we need the full path to a `tracev3` file we want to parse to `parse_log()`.
1. `parse_log(&str)` Returns a `Result<UnifiedLogData, ParserError>` which is a structure containing the parsed Unified Log data

Now we have all data needed to construct the Unified Log entries.
Before building the logs, the caller will need to decide how to deal with log data that is stored in a different `tracev3` file.
Sometimes a `tracev3` will reference log data in another `tracev3` file, specifically the log data may reference `Oversize` data in different `tracev3` file.
The function to construct the Unified Log data `build_log()` can be leveraged to both construct the logs and help track which logs may have data in a different `tracev3` files
`build_log()` expects: `&UnifiedLogData, &[UUIDText], &[SharedCacheStrings], &[TimesyncBoot], bool`

1. `build_log(&UnifiedLogData, &[UUIDText], &[SharedCacheStrings], &[TimesyncBoot], exclude_missing: bool)` Returns a `(Vec<LogData>, UnifiedLogData)`

Passing a `true` bool to `build_log()` will cause it to exclude all `UnifiedLogData` entries from `Vec<LogData>`, if it fails to find the correct `Oversize` data in the provided `UnifiedLogData`.
By tracking the excluded data separately you can parse each `tracev3` files and collect any entries that failed to build. Once all `tracev3` files are parsed you take a Vector of excluded `UnifiedLogData` and call `build_log` one more time to build any logs that had `Oversize` data in another `tracev3` file. Since all `tracev3` files are now parsed we have all the `Oversize` data and should be able to find all log entries that had data in another file.
The example projects `unifiedlog_parser` and `unifiedlog_parse_json` both pass `true` to `build_log()`

Passing `false` bool to `build_log()` will cause it include all `UnifiedLogData` entries in `Vec<LogData>` EVEN IF IT FAILED to find `Oversize` data in the parsed `tracev3` file. Any log entries that reference a different `tracev3` file will have data labeled `<Missing message data>`

Once `build_log()` has constructed the Unified Log entries you should immediantly output or upload the returned `Vec<LogData>` before parsing other `tracev3` files. Parsing all `tracev3` files and appending the results to single Vector will increase total memory usage extremely fast.
The example files `unifiedlog_parser` and `unifiedlog_parse_json` both output `Vec<LogData>` to a file and discards the results before parsing the next `tracev3` file

The example projects `unifiedlog_parser` and `unifiedlog_parse_json` both support parsing on a live system if run with no arguements.

## Custom paths
Similar to `parse_log()` you can also provide custom paths for the UUID, UUID cache, and Timesync files:
1. `collect_shared_strings(&str)` Expects a path containing UUID Cache files (ex: `/private/var/db/uuidtext/dsc`)
2. `collect_timesync(&str)` Expects a path containing timesync files (ex: `/private/var/db/diagnostics/timesync`)
Both functions return the same values as `collect_shared_strings_system() and collect_timesync_system()`

3. `collect_strings(&str)` Expects a path containing one (1) or more, two (2) character subdirectories that contain UUID files (ex: `/private/var/db/uuidtext`). Each subdirectory should contain the UUID file(s). This function returns the same value as `collect_strings_system()`

Parsing the `tracev3` files then follows the same process as mentioned in parsing on a `Live System`

The example projects `unifiedlog_parser` and `unifiedlog_parse_json` both support parsing custom paths that follow the same structure as a `logarchive`
```
./unifiedlog_parser system.logarchive/
```
202 changes: 202 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2022 Mandiant, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit 35a5153

Please sign in to comment.