# y1z2g3/yara-java architecture

> Architecture diagram of the GitHub repository y1z2g3/yara-java, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/y1z2g3/yara-java
- Repository: https://github.com/y1z2g3/yara-java

## Overview

##### Core Components

a) Interface Layer (Top):
- Callback interfaces: `YaraCompilationCallback`, `YaraScanCallback`
- Model classes: `YaraRule`, `YaraMatch`, `YaraMeta`, `YaraString`

b) Implementation Layer (Middle) - Split into two parallel paths:
Left Side - Embedded Mode:
- `YaraImpl` (embedded)
- `YaraCompilerImpl` (embedded)
- `YaraScannerImpl` (embedded)
- `YaraLibrary` (JNI bridge)

Right Side - External Mode:
- `YaraImpl` (external)
- `YaraCompilerImpl` (external)
- `YaraScannerImpl` (external)
- `YaraExecutable` and `YaracExecutable`

c) Native Layer (Bottom):
- YARA Native Library (embedded mode)
- YARA External Process (external mode)

##### Specific details

a) Factory Pattern:
- `YaraFactory` as the central point for creating instances
- Demonstrate how it creates either embedded or external implementations

b) Component Relationships:
- How `YaraCompiler` creates rules that feed into `YaraScanner`
- Callback mechanisms for compilation and scanning
- File/archive handling for rules

##### Important Notes

a) Annotations for:
- Shared YR_RULES structure in embedded mode
- Process boundaries in external mode
- Native resource management
- Threading considerations

##### Technical Details

Technical notes for:
- JNI bridge implementation
- Native library requirements
- External process communication
- Resource lifecycle management

Remember to emphasize the factory pattern's role in abstracting the implementation details and how the system manages native resources in both modes of operation.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Style Definitions
    classDef interface fill:#e1f5fe,stroke:#01579b
    classDef model fill:#e8f5e9,stroke:#2e7d32
    classDef embedded fill:#c8e6c9,stroke:#2e7d32
    classDef external fill:#ffe0b2,stroke:#ef6c00
    classDef native fill:#f5f5f5,stroke:#424242
    classDef factory fill:#e1bee7,stroke:#6a1b9a

    %% Interface Layer
    subgraph InterfaceLayer
        Yara["Yara Interface"]:::interface
        YCompiler["YaraCompiler"]:::interface
        YScanner["YaraScanner"]:::interface
        CompCallback["YaraCompilationCallback"]:::interface
        ScanCallback["YaraScanCallback"]:::interface
        
        %% Model Classes
        YRule["YaraRule"]:::model
        YMatch["YaraMatch"]:::model
        YMeta["YaraMeta"]:::model
        YString["YaraString"]:::model
    end

    %% Factory
    YFactory["YaraFactory"]:::factory

    %% Implementation Layer
    subgraph EmbeddedMode
        EYara["YaraImpl\n(Embedded)"]:::embedded
        ECompiler["YaraCompilerImpl\n(Embedded)"]:::embedded
        EScanner["YaraScannerImpl\n(Embedded)"]:::embedded
        YLib["YaraLibrary\n(JNI Bridge)"]:::embedded
    end

    subgraph ExternalMode
        XYara["YaraImpl\n(External)"]:::external
        XCompiler["YaraCompilerImpl\n(External)"]:::external
        XScanner["YaraScannerImpl\n(External)"]:::external
        YExec["YaraExecutable"]:::external
        YCExec["YaracExecutable"]:::external
    end

    %% Native Layer
    subgraph NativeLayer
        NativeLib["YARA Native Library"]:::native
        ExtProcess["YARA External Process"]:::native
    end

    %% Relationships
    YFactory --> EYara
    YFactory --> XYara
    Yara --> |implements| EYara
    Yara --> |implements| XYara
    YCompiler --> |implements| ECompiler
    YCompiler --> |implements| XCompiler
    YScanner --> |implements| EScanner
    YScanner --> |implements| XScanner
    
    EYara --> YLib
    ECompiler --> YLib
    EScanner --> YLib
    YLib --> NativeLib
    
    XYara --> YExec
    XCompiler --> YCExec
    XScanner --> YExec
    YExec --> ExtProcess
    YCExec --> ExtProcess

    CompCallback -.-> YCompiler
    ScanCallback -.-> YScanner
    YRule -.-> YScanner
    YMatch -.-> ScanCallback
    YMeta -.-> YRule
    YString -.-> YRule

    %% Click Events
    click Yara "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/Yara.java"
    click YCompiler "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraCompiler.java"
    click YScanner "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraScanner.java"
    click CompCallback "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraCompilationCallback.java"
    click ScanCallback "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraScanCallback.java"
    click YRule "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraRule.java"
    click YMatch "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraMatch.java"
    click YMeta "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraMeta.java"
    click YString "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraString.java"
    click EYara "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/embedded/YaraImpl.java"
    click ECompiler "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/embedded/YaraCompilerImpl.java"
    click EScanner "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/embedded/YaraScannerImpl.java"
    click YLib "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/embedded/YaraLibrary.java"
    click XYara "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/external/YaraImpl.java"
    click XCompiler "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/external/YaraCompilerImpl.java"
    click XScanner "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/external/YaraScannerImpl.java"
    click YExec "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/external/YaraExecutable.java"
    click YCExec "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/external/YaracExecutable.java"
    click YFactory "https://github.com/y1z2g3/yara-java/blob/master/src/main/java/com/github/plusvic/yara/YaraFactory.java"
    click NativeLib "https://github.com/y1z2g3/yara-java/blob/master/src/main/native-package/src/yara-wrapper.h"
```
