Plyara

What's Changed

Bugfixes

* Fixed a regression introduced by https://github.com/plyara/plyara/commit/0430454310d401d05cf60fca388ceb636c1877b7 where the rule end line number was incorrect. By vitaly-kamluk in https://github.com/plyara/plyara/pull/157

New Contributor

* vitaly-kamluk made their first contribution in https://github.com/plyara/plyara/pull/157

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.6...v2.2.7

Bugfix Release

- Fix regression introduced with narrowing of characterset for strings. Reported by utkonos in https://github.com/plyara/plyara/issues/154

**NOTE**: This regression was discovered due to progress in a major testing project for plyara tracked in 146. If you want to help, testing those rule repositories and opening issues for any crashes or inconsistencies would be a great help to the project overall.

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.5...v2.2.6

Bugfix Release

Bugfixes

- Fixed comments between rules being properly discarded and not attached to a rule. Reported by utkonos in https://github.com/plyara/plyara/issues/150
- Nums and Hexnums have the same limit at which YARA returns an integer overflow error. Reported by utkonos in https://github.com/plyara/plyara/issues/151
- Tags now cannot contain `.`. Reported by utkonos in https://github.com/plyara/plyara/issues/152
- Bytestring comments now have the correct line number. Reported by utkonos in https://github.com/plyara/plyara/issues/153

Unit Tests

- Unit test coverage is now 100% in the following modules. Reported by utkonos in https://github.com/plyara/plyara/issues/138
- `core.py`
- `exceptions.py`
- `command_line.py`
- The following functions need a maintainer to clean them up and write 100% unit tests:
- `utils.generate_hash`
- `rebuild_yara_rule`

Deprecations

- `utils.is_valid_rule_name` is deprecated because the parser handles rule name validation now. Function will be removed in version 2.3.
- `utils.is_valid_rule_tag` is deprecated because the parser handles tag name validation now. Function will be removed in version 2.3.
- `utils.detect_imports` is deprecated because imports are now properly reported in each rule by default. Function will be removed in version 2.3.
- `utils.detect_dependencies` is deprecated because imports are now properly reported in each rule by default. Function will be removed in version 2.3.

Removed

- `utils.generate_logic_hash` is now removed. If you need this functionality, use `utils.generate_hash`.

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.4...v2.2.5

Bugfix Release

- Fixed improper handling of comments in various locations. Found during unit test overhaul by utkonos in https://github.com/plyara/plyara/issues/147

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.3...v2.2.4

Bugfix Release

- Fix problem with clearing the parser after an exception has been raised. Reported by dadokkio in [118](https://github.com/plyara/plyara/issues/118)
- Fix a set of regressions involving negative number parsing and xor modifiers. Reported by Neo23x0 in [143](https://github.com/plyara/plyara/issues/143)
- Fix negative integer parsing in metadata. Reported by kam193 in https://github.com/CybercentreCanada/assemblyline/issues/231
- Add unit tests for negative number parsing in PR made by cccs-rs in [130](https://github.com/plyara/plyara/pull/130)
- Add unit tests for negated hex string byte parsing in PR made by cccs-rs in [130](https://github.com/plyara/plyara/pull/130)

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.2...v2.2.3

Squashing Bugs!!!

Breaking Changes
* Add versions and algo names to logic hashes retaining old behavior as a non-default option requested by utkonos in https://github.com/plyara/plyara/issues/105

Bug Fixes
* Fixed illegal string name character `-` reported by rakovskij-stanislav in https://github.com/plyara/plyara/issues/115
* Fixed handling of negative numbers in conditions including hex numbers reported by rakovskij-stanislav in https://github.com/plyara/plyara/issues/112
* Handle placeholders correctly in `utils.generate_hash()` reported by utkonos in https://github.com/plyara/plyara/issues/136 and https://github.com/plyara/plyara/issues/137

Unit Testing
* Removed unused unit test data files by utkonos
* Added test for bad condition string by utkonos
* Helper bash script for finding unused unit test data files by utkonos
* Added tests for xor and base64 problems by utkonos
* Reorganized unit tests into directories per unit test suite by utkonos

Documentation Changes
* Add YARA-X `fmt` preprocessing workaround for formatting issues by utkonos
* Removed ancient documentation by utkonos

Deprecation
* `utils.generate_logic_hash()` will be removed in the next release

**Full Changelog**: https://github.com/plyara/plyara/compare/v2.2.1...v2.2.2