add initial project documentation
This commit is contained in:
commit
ad9be0ba91
7 changed files with 1443 additions and 0 deletions
160
CODE_OF_CONDUCT.md
Normal file
160
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
# Code of Conduct
|
||||
|
||||
## 1. Purpose
|
||||
|
||||
This Code of Conduct establishes standards of behavior to ensure a professional,
|
||||
inclusive, and respectful environment for all contributors, maintainers, and users
|
||||
of the Bastionguard project.
|
||||
|
||||
The project is committed to maintaining a safe, collaborative, and high-integrity
|
||||
community focused on defensive cybersecurity and ethical development.
|
||||
|
||||
---
|
||||
|
||||
## 2. Scope
|
||||
|
||||
This Code of Conduct applies to all project spaces, including but not limited to:
|
||||
|
||||
- Source code repositories
|
||||
- Issue trackers
|
||||
- Pull requests and code reviews
|
||||
- Discussion forums and chat platforms
|
||||
- Mailing lists and social media channels
|
||||
- Events and public communications related to the project
|
||||
|
||||
It applies to all participants, including maintainers, contributors, users,
|
||||
and external collaborators.
|
||||
|
||||
---
|
||||
|
||||
## 3. Core Values
|
||||
|
||||
Participants are expected to uphold the following principles:
|
||||
|
||||
- Professionalism and integrity
|
||||
- Technical excellence and accountability
|
||||
- Respect for diverse perspectives
|
||||
- Transparency in decision-making
|
||||
- Responsible security practices
|
||||
- Ethical use of software
|
||||
|
||||
---
|
||||
|
||||
## 4. Expected Behavior
|
||||
|
||||
All participants must:
|
||||
|
||||
- Communicate respectfully and constructively
|
||||
- Provide clear, factual, and technically sound feedback
|
||||
- Accept constructive criticism in good faith
|
||||
- Follow secure coding practices
|
||||
- Respect intellectual property and licensing terms
|
||||
- Report security issues responsibly
|
||||
- Avoid conflicts of interest
|
||||
- Act in the best interest of the project and its users
|
||||
|
||||
---
|
||||
|
||||
## 5. Unacceptable Behavior
|
||||
|
||||
The following behaviors are strictly prohibited:
|
||||
|
||||
- Harassment, discrimination, or hate speech of any kind
|
||||
- Personal attacks, insults, or derogatory comments
|
||||
- Trolling, intimidation, or deliberate disruption
|
||||
- Publishing private or confidential information
|
||||
- Impersonation or misrepresentation
|
||||
- Promotion or facilitation of illegal activities
|
||||
- Development or promotion of offensive security tools
|
||||
intended for malicious use
|
||||
- Knowingly introducing vulnerabilities or backdoors
|
||||
- Circumventing security controls without authorization
|
||||
- Abuse of project infrastructure or resources
|
||||
|
||||
---
|
||||
|
||||
## 6. Security and Responsible Disclosure
|
||||
|
||||
Security vulnerabilities must be reported privately and responsibly.
|
||||
|
||||
Participants must not publicly disclose security flaws before
|
||||
maintainers have had reasonable time to assess and remediate them.
|
||||
|
||||
Unauthorized exploitation of vulnerabilities is prohibited.
|
||||
|
||||
---
|
||||
|
||||
## 7. Enforcement
|
||||
|
||||
Project maintainers are responsible for enforcing this Code of Conduct.
|
||||
|
||||
They may take any action deemed appropriate, including but not limited to:
|
||||
|
||||
- Warning
|
||||
- Temporary suspension
|
||||
- Permanent ban
|
||||
- Rejection or removal of contributions
|
||||
- Revocation of contributor privileges
|
||||
- Legal action, where applicable
|
||||
|
||||
Enforcement decisions will be made in good faith and documented
|
||||
when appropriate.
|
||||
|
||||
---
|
||||
|
||||
## 8. Reporting Violations
|
||||
|
||||
Violations should be reported to the project maintainers through
|
||||
a designated private channel.
|
||||
|
||||
Reports must include:
|
||||
|
||||
- Description of the incident
|
||||
- Relevant evidence
|
||||
- Dates and locations
|
||||
- Involved parties
|
||||
|
||||
All reports will be handled confidentially.
|
||||
|
||||
Retaliation against reporters is strictly prohibited.
|
||||
|
||||
---
|
||||
|
||||
## 9. Governance and Appeals
|
||||
|
||||
Participants may request a review of enforcement actions.
|
||||
|
||||
Appeals must be submitted in writing and will be evaluated
|
||||
by the core maintainer team.
|
||||
|
||||
Decisions following review are final.
|
||||
|
||||
---
|
||||
|
||||
## 10. Legal and Compliance
|
||||
|
||||
All participants must comply with:
|
||||
|
||||
- Applicable laws and regulations
|
||||
- Export control and sanctions laws
|
||||
- Data protection and privacy regulations
|
||||
- Project licensing terms (GPLv3)
|
||||
- Trademark usage guidelines
|
||||
|
||||
Non-compliance may result in immediate removal from the project.
|
||||
|
||||
---
|
||||
|
||||
## 11. Amendments
|
||||
|
||||
This Code of Conduct may be updated by project maintainers
|
||||
to reflect legal, technical, or community changes.
|
||||
|
||||
Updates will be publicly documented.
|
||||
|
||||
---
|
||||
|
||||
## 12. Acknowledgment
|
||||
|
||||
By participating in the Bastionguard project,
|
||||
you agree to abide by this Code of Conduct.
|
||||
150
CONTRIBUTING.md
Normal file
150
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
# Contributing Guidelines
|
||||
|
||||
Thank you for your interest in contributing to BastionGuard.
|
||||
|
||||
This document defines the rules and procedures required to ensure
|
||||
high standards of quality, security, and consistency within the project.
|
||||
|
||||
---
|
||||
|
||||
## General Requirements
|
||||
|
||||
All contributors must:
|
||||
|
||||
- Comply with the Code of Conduct
|
||||
- Accept the GPLv3 license
|
||||
- Follow the Security Policy
|
||||
- Respect this document
|
||||
|
||||
Contributions that do not meet these requirements
|
||||
may be rejected without further notice.
|
||||
|
||||
---
|
||||
|
||||
## Types of Contributions
|
||||
|
||||
The following types of contributions are welcome:
|
||||
|
||||
- Bug fixes
|
||||
- Performance improvements
|
||||
- Approved new features
|
||||
- Documentation enhancements
|
||||
- Automated tests
|
||||
- Security reviews and audits
|
||||
|
||||
The following contributions are not accepted:
|
||||
|
||||
- Offensive or malicious functionality
|
||||
- Code intended for illegal activities
|
||||
- Security bypass mechanisms
|
||||
- Violations of third-party rights
|
||||
- Obfuscated or intentionally misleading code
|
||||
|
||||
---
|
||||
|
||||
## Contribution Process
|
||||
|
||||
### 1. Issue Reporting
|
||||
|
||||
Before submitting major changes, contributors should:
|
||||
|
||||
- Search for existing issues
|
||||
- Open a new issue describing the proposal
|
||||
- Wait for maintainer feedback when required
|
||||
|
||||
---
|
||||
|
||||
### 2. Fork and Branch
|
||||
|
||||
Contributors must:
|
||||
|
||||
- Fork the official repository
|
||||
- Create a dedicated branch for each change
|
||||
- Use descriptive branch names
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
---
|
||||
|
||||
### 3. Development Standards
|
||||
|
||||
All code contributions must:
|
||||
|
||||
- Follow the project's coding style
|
||||
- Include appropriate documentation
|
||||
- Provide unit and integration tests where applicable
|
||||
- Avoid introducing breaking changes without approval
|
||||
- Maintain backward compatibility when possible
|
||||
|
||||
---
|
||||
|
||||
### 4. Security Requirements
|
||||
|
||||
Contributors must:
|
||||
|
||||
- Follow secure coding practices
|
||||
- Avoid hardcoded credentials or secrets
|
||||
- Prevent introduction of known vulnerabilities
|
||||
- Report discovered security issues privately
|
||||
|
||||
Security-related changes may be subject to additional review.
|
||||
|
||||
---
|
||||
|
||||
### 5. Commit and Pull Request Rules
|
||||
|
||||
Commits must:
|
||||
|
||||
- Be atomic and focused
|
||||
- Include clear and descriptive messages
|
||||
- Reference relevant issues
|
||||
|
||||
Pull Requests must:
|
||||
|
||||
- Describe the purpose and scope of changes
|
||||
- Pass all automated checks
|
||||
- Address reviewer feedback
|
||||
- Not include unrelated modifications
|
||||
|
||||
---
|
||||
|
||||
### 6. Review and Approval
|
||||
|
||||
All contributions are subject to review by maintainers.
|
||||
|
||||
Approval requires:
|
||||
|
||||
- Technical correctness
|
||||
- Security compliance
|
||||
- Alignment with project goals
|
||||
- Documentation completeness
|
||||
|
||||
Maintainers reserve the right to request changes or reject submissions.
|
||||
|
||||
---
|
||||
|
||||
### 7. Licensing
|
||||
|
||||
By submitting a contribution, you confirm that:
|
||||
|
||||
- You have the right to submit the code
|
||||
- Your contribution is licensed under GPLv3
|
||||
- You grant the project the right to redistribute it
|
||||
|
||||
Contributions violating licensing terms will be rejected.
|
||||
|
||||
---
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
All contributors must follow the Code of Conduct.
|
||||
Violations may result in suspension or permanent exclusion.
|
||||
|
||||
---
|
||||
|
||||
## Contact
|
||||
|
||||
For questions related to contributions:
|
||||
|
||||
info@bastionguard.eu
|
||||
140
GOVERNANCE.md
Normal file
140
GOVERNANCE.md
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
# Project Governance
|
||||
|
||||
This document defines the governance model for the BastionGuard project.
|
||||
|
||||
It establishes roles, responsibilities, and decision-making processes
|
||||
to ensure transparency, accountability, and long-term sustainability.
|
||||
|
||||
---
|
||||
|
||||
## Project Structure
|
||||
|
||||
The project is governed by the Core Maintainer Team.
|
||||
|
||||
The Core Maintainers are responsible for:
|
||||
|
||||
- Defining project direction
|
||||
- Managing releases
|
||||
- Reviewing and approving contributions
|
||||
- Enforcing policies
|
||||
- Handling security incidents
|
||||
- Protecting the project trademark
|
||||
|
||||
---
|
||||
|
||||
## Roles
|
||||
|
||||
### Core Maintainers
|
||||
|
||||
Core Maintainers:
|
||||
|
||||
- Have full write access to the repository
|
||||
- Approve major changes and releases
|
||||
- Resolve disputes
|
||||
- Represent the project publicly
|
||||
|
||||
Appointment is based on:
|
||||
|
||||
- Technical merit
|
||||
- Long-term contribution
|
||||
- Security awareness
|
||||
- Community conduct
|
||||
|
||||
---
|
||||
|
||||
### Maintainers
|
||||
|
||||
Maintainers:
|
||||
|
||||
- Review pull requests
|
||||
- Manage specific modules
|
||||
- Support contributors
|
||||
- Report to Core Maintainers
|
||||
|
||||
Maintainers are appointed by the Core Maintainer Team.
|
||||
|
||||
---
|
||||
|
||||
### Contributors
|
||||
|
||||
Contributors:
|
||||
|
||||
- Submit code, documentation, or reports
|
||||
- Participate in discussions
|
||||
- Follow project policies
|
||||
|
||||
No special privileges are granted by default.
|
||||
|
||||
---
|
||||
|
||||
## Decision-Making Process
|
||||
|
||||
### Technical Decisions
|
||||
|
||||
- Minor changes: Maintainer approval
|
||||
- Major changes: Core Maintainer review
|
||||
- Architectural changes: Formal proposal and consensus
|
||||
|
||||
Consensus is preferred. If consensus cannot be reached,
|
||||
Core Maintainers have final authority.
|
||||
|
||||
---
|
||||
|
||||
### Policy Decisions
|
||||
|
||||
Changes to governance, licensing, or policies require
|
||||
approval by the Core Maintainer Team.
|
||||
|
||||
---
|
||||
|
||||
## Release Management
|
||||
|
||||
Releases are managed by Core Maintainers.
|
||||
|
||||
Each release must:
|
||||
|
||||
- Pass security audits
|
||||
- Meet quality standards
|
||||
- Include documentation
|
||||
- Be cryptographically signed when applicable
|
||||
|
||||
---
|
||||
|
||||
## Conflict Resolution
|
||||
|
||||
Disputes are handled according to the Code of Conduct.
|
||||
|
||||
Unresolved conflicts are escalated to Core Maintainers.
|
||||
|
||||
Their decision is final.
|
||||
|
||||
---
|
||||
|
||||
## Security Governance
|
||||
|
||||
All security-related matters are coordinated
|
||||
through the Security Policy.
|
||||
|
||||
The Core Maintainers oversee:
|
||||
|
||||
- Vulnerability handling
|
||||
- Incident response
|
||||
- Disclosure coordination
|
||||
|
||||
---
|
||||
|
||||
## Trademark Governance
|
||||
|
||||
Use of the BastionGuard trademark is governed
|
||||
by the Trademark Policy.
|
||||
|
||||
Unauthorized use may result in legal action.
|
||||
|
||||
---
|
||||
|
||||
## Amendments
|
||||
|
||||
This governance model may be updated
|
||||
by the Core Maintainer Team.
|
||||
|
||||
All changes will be documented publicly.
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
175
README.md
Normal file
175
README.md
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
# BastionGuard™ Endpoint 1.0
|
||||
|
||||
BastionGuard™ Endpoint is an independent Android endpoint security application designed to provide antivirus scanning, real-time protection, anti-phishing, ransomware defense, quarantine, and other security capabilities with a privacy-first, local-processing approach.
|
||||
|
||||
## Implemented
|
||||
|
||||
- Jetpack Compose dashboard and scan-results UI in the same dark/emerald visual language.
|
||||
- Runtime SaneSecurity signature updater. Signature payloads are **not bundled** in this source archive or APK.
|
||||
- Native YARA-X 1.19.0 heuristic engine through Rust/JNI, with DEX/ELF-aware rules, strict mobile time/size budgets and compiled-rule caching.
|
||||
- Every bundled BastionGuard YARA rule declares `author = "Calogero Scarnà"`; both the project validator and the on-device loader reject rule sets that violate this requirement.
|
||||
- Local parser/engine for SaneSecurity/ClamAV-style:
|
||||
- HDB / HSB exact file hashes (MD5/SHA-1/SHA-256 according to hash length).
|
||||
- NDB extended hex signatures with fixed bytes, `??`, nibble wildcards, `*`, `{n}`, `{-n}`, `{n-}`, `{n-m}`.
|
||||
- IGN / IGN2 whitelist names.
|
||||
- Unsupported ClamAV constructs are skipped conservatively and counted in the UI.
|
||||
- APK/ZIP scanning: whole-file hashes plus bounded archive-entry inspection for realtime/single-item scans. Bulk scans use the fast path to avoid repeatedly inflating archives already protected at download time.
|
||||
- Real-time protection foreground service:
|
||||
- progressive `CREATE`/`MODIFY` inspection of readable browser downloads while bytes are still arriving;
|
||||
- immediate full-file scan on `CLOSE_WRITE`/`MOVED_TO`, with no artificial settle delay;
|
||||
- immediate deep archive/APK inspection for completed browser downloads, even under battery saver/Doze;
|
||||
- `MediaStore.Downloads` plus filtered `MediaStore.Files` observation on Android 10+, so browser-owned downloads saved to custom shared folders are covered too;
|
||||
- Android `DownloadManager.ACTION_DOWNLOAD_COMPLETE` as an extra completion signal, deduplicated against filesystem/MediaStore events;
|
||||
- package-added/package-replaced receiver to scan the installed source APK after installation.
|
||||
- High-throughput scanning engine: bounded 2–3 worker parallelism, one-pass hash + body-prefix I/O, throttled UI progress updates, and cooperative cancellation checked during traversal and file reads.
|
||||
- The scan-results screen exposes **Stop scan** while a scan is running; cancellation shows partial results and does not overwrite the last completed dashboard scan.
|
||||
- Full device scan:
|
||||
- all user-accessible shared-storage files when All files access is granted;
|
||||
- installed application source APKs.
|
||||
- Night scan scheduled around 02:30 with WorkManager, requiring charging and battery-not-low.
|
||||
- Phishing-email analysis through Android Share / Process Text for text, HTML, RFC822/EML-style content and shared attachments.
|
||||
- Link Guard pre-click URL scoring with Safe/Balanced/Aggressive thresholds, Android link-handler integration, a user-selectable external browser, and local allow/block overrides.
|
||||
- Optional Browser Shield using explicitly enabled Android Accessibility access to inspect only the active browser address bar, check the normalized domain, and show Link Guard-style phishing warnings while browsing.
|
||||
- Ransomware Guard correlating shared-storage write/delete/rename bursts, extension mutations, entropy changes and harmless canary files; high-confidence events trigger an immediate local security response and alert.
|
||||
- Cross-engine global threat score that time-decays and rewards corroboration between independent security categories.
|
||||
- Mandatory private quarantine for detected ordinary shared-storage files, with restore-to-trusted SHA-256 allowlisting.
|
||||
- Threat notifications and persistent real-time-protection notification, including live manual-scan and download activity status.
|
||||
- Dashboard phishing-domain checker with in-app results, bounded HTML fetch, SaneSecurity/YARA-X matching and local heuristics.
|
||||
- Multilingual UI matching the previous BastionGuard app: Italian, English, French, German, Arabic, Japanese, Spanish, Portuguese, Polish, Dutch and Russian.
|
||||
- First-run language selector plus an in-app Language screen; AppCompat persists the selected locale on Android 12 and lower, while Android 13+ exposes the declared app locales through the platform per-app language system.
|
||||
- RTL support remains enabled for Arabic.
|
||||
|
||||
## Localization
|
||||
|
||||
The base resources are English (`values/strings.xml`). The same 331 user-facing strings are present in `values-it`, `values-de`, `values-es`, `values-fr`, `values-pt`, `values-nl`, `values-pl`, `values-ru`, `values-ja`, and `values-ar`. The first-run language flow and supported-language order mirror the supplied BastionGuard Secure Bank source. Notifications, scan status text, phishing results, quarantine metadata and detection-kind labels use localized resources instead of hardcoded Italian UI text.
|
||||
|
||||
See `docs/LOCALIZATION.md` for the locale list and implementation details.
|
||||
|
||||
## Android security boundary
|
||||
|
||||
A normal Play-distributed Android app cannot inspect other apps' private `/data/data/...` content and cannot universally intercept every package installation before Package Installer runs. BastionGuard therefore scans downloads as they appear, scans APK files before/after installation when accessible, scans installed source APKs, and scans all user-accessible shared storage.
|
||||
|
||||
Email protection uses Android Notification Access only when explicitly enabled, and Android Share for complete messages/attachments. Browser Shield accessibility access is **not** used to scrape Gmail or other mail clients; email protection remains limited to notification access and explicit Share/Process Text flows. For phishing URLs/domains found in mail, the app checks BastionGuard online intelligence first and then runs the local SaneSecurity/YARA-X layer; the surrounding message text and attachments are not uploaded to the online phishing checker.
|
||||
|
||||
## Advanced protection boundary
|
||||
|
||||
Link Guard and Ransomware Guard are implemented without bypassing Android security boundaries. Link-handler protection is activated through Android's default-app/browser-role flow. The consumer build contains no VPN Network Shield and does not claim a global network kill-switch that stock Android cannot provide to an ordinary app. Ransomware Guard observes only storage that the antivirus is authorized to scan and does not inspect another app's private sandbox. See `docs/ADVANCED_PROTECTION.md` for architecture, thresholds, limitations and privacy behavior.
|
||||
|
||||
## SaneSecurity integration
|
||||
|
||||
Default public mirror build setting:
|
||||
|
||||
`BuildConfig.SANE_SIGNATURE_BASE_URL = https://ftp.swin.edu.au/sanesecurity/`
|
||||
|
||||
For production, configure a SaneSecurity-approved mirror/private donor URL and coordinate commercial-product usage with SaneSecurity. The downloader has a four-hour anti-abuse floor and the scheduled update cadence is six hours.
|
||||
|
||||
Configured databases:
|
||||
|
||||
- `phish.ndb`
|
||||
- `blurl.ndb`
|
||||
- `jurlbl.ndb`
|
||||
- `scam.ndb`
|
||||
- `spear.ndb`
|
||||
- `spearl.ndb`
|
||||
- `badmacro.ndb`
|
||||
- `rogue.hdb`
|
||||
- `malwarehash.hsb`
|
||||
- `hackingteam.hsb`
|
||||
- `spamattach.hdb`
|
||||
- `sigwhitelist.ign2`
|
||||
|
||||
The project intentionally does not redistribute these database payloads.
|
||||
|
||||
## Build
|
||||
|
||||
Open this folder with Android Studio using JDK 17+ and sync Gradle. For command-line builds, `./build-debug.sh` uses the project Wrapper when present; otherwise it bootstraps the official Gradle 9.6.1 binary distribution with SHA-256 verification instead of relying on distro-packaged Gradle. See `docs/GRADLE_BOOTSTRAP.md`. The project uses:
|
||||
|
||||
- compileSdk 37
|
||||
- targetSdk 36
|
||||
- minSdk 26
|
||||
- AGP 9.3.0
|
||||
- Kotlin Compose plugin 2.4.10
|
||||
- WorkManager 2.11.2
|
||||
- YARA-X 1.19.0 via Rust 1.91.0 + Android NDK/cargo-ndk
|
||||
|
||||
The YARA-X bridge is compiled from `native/yarax-android` with Rust/cargo-ndk. Run `./build-debug.sh`: when the three required native libraries are absent it invokes `./build-yarax-android.sh` first, then runs validation, unit tests and the Android debug build. This source archive intentionally does not contain prebuilt YARA-X `.so` binaries.
|
||||
|
||||
See `docs/YARA_X_INTEGRATION.md` for the native architecture, performance limits and rule-author policy.
|
||||
|
||||
## YARA-X integration
|
||||
|
||||
BastionGuard keeps SaneSecurity as the low-cost first layer and adds YARA-X as a bounded second layer for APK/DEX/native payloads, scripts, phishing content and selected high-value file types. APK acquisition and installed-app scans perform a bounded security pass over `classes*.dex` and `lib/**/*.so`; deeper generic archive recursion remains resource-controlled. Under the current protection policy, readable shared-storage files are quarantined only after the scan result is actionable; a file restored by the user is trusted by its exact SHA-256.
|
||||
|
||||
Bundled rules live in `app/src/main/assets/yara/` and all of them carry the exact author metadata `Calogero Scarnà`. Android/native heuristic rules use correlation-aware scores: the strongest rule per behavioral category contributes to a 0..100 risk score and correlation-required heuristics need at least 80/100 before BastionGuard treats the result as infected. A single loader, root-check, accessibility or native-memory capability therefore remains informational instead of becoming an automatic malware verdict.
|
||||
|
||||
## Google Play
|
||||
|
||||
Read `docs/PLAY_STORE_RELEASE.md` before publishing. The app requests permissions that require Play Console declarations because antivirus scanning is its core purpose.
|
||||
|
||||
The supplied visual mockup is copied to `docs/mockup-reference.png` only as a design reference; it is **not** presented as an actual application screenshot.
|
||||
|
||||
## UI revision aligned to the supplied antivirus mockup
|
||||
|
||||
The dashboard now follows the supplied BastionGuard antivirus mockup instead of exposing developer-style controls on the home screen. The hamburger menu is functional and contains the antivirus sections plus Settings. Scan targets are selected from a dedicated screen (Quick, Full device, Internal storage, microSD/removable storage when detected, Downloads, installed apps/APKs). Language selection is under Settings, not on the dashboard. Real-time protection runs through an Android foreground service with an ongoing notification. The exact user-supplied BastionGuard SVG is retained in `app/src/main/res/raw/bastionguard_logo_source.svg` and rendered for the in-app/notification large icon; the Android small notification icon is a monochrome shield derived from that mark as required by Android.
|
||||
|
||||
|
||||
## Fast scan / cancellation revision
|
||||
|
||||
Manual scans now use a bounded parallel pipeline rather than scanning every file serially. Small/risk-relevant content is hashed and its NDB inspection prefix is captured in a single filesystem pass, reducing duplicate reads. Bulk scans do not recursively inflate every ZIP/APK entry; persistent realtime scanning retains deep archive inspection for newly downloaded individual items. The scan UI has an explicit Stop scan action. Cancellation is cooperative and checked between directories and on every file I/O buffer so it normally responds quickly without corrupting scan state.
|
||||
|
||||
### Automatic email phishing checks
|
||||
|
||||
The optional `EmailNotificationScanService` uses Android Notification Access to scan new-message subject/body previews from email clients. It is declared with `android.permission.BIND_NOTIFICATION_LISTENER_SERVICE`; the user grants the special access from Android settings. Full mailbox access is not claimed or requested. URL/domain indicators extracted from a preview are checked first by BastionGuard online intelligence; the preview is then scanned locally with SaneSecurity/YARA-X. Complete messages and attachments sent through Android Share use the same online-indicator-first/local-engine-second order.
|
||||
|
||||
### Desktop-parity phishing intelligence
|
||||
|
||||
The in-app domain checker calls `https://bastionguard.eu/bastionguard-security-intelligence/?q=...`, mirroring the desktop `phishing_search` GET lookup. The Android parser recognizes the desktop classifications and the `Matched Indicator` field. A non-empty matched indicator is treated as an authoritative online phishing hit even if surrounding page markup changes, and is covered by a unit regression test. Local SaneSecurity/YARA-X analysis always follows, including when the online engine is unavailable.
|
||||
|
||||
### Identity Leak password check
|
||||
|
||||
`Identity Leak` is available from the left drawer. The Android implementation follows BastionGuard desktop `HibpPasswordProvider`: SHA-1 is computed locally, only the first five uppercase hexadecimal characters are sent to the HIBP Pwned Passwords Range endpoint with `Add-Padding: true`, and the returned 35-character suffix is compared locally for an exact match and occurrence count. The password field is cleared before the background request starts; passwords and full hashes are not persisted or logged.
|
||||
|
||||
### Quarantine management
|
||||
|
||||
The quarantine list is counted directly from verified private payload/metadata pairs. Each item is numbered and can be restored to its original path or permanently deleted. Restore never overwrites an existing destination and removes the isolated copy only after the restored file size is verified.
|
||||
|
||||
## YARA-X community rules
|
||||
|
||||
In addition to the bundled BastionGuard YARA-X rules (`author = "Calogero Scarnà"`), the app can download a public Yara-Rules community feed at runtime without an account. The Android profile imports `mobile_malware` and `email`, validates them with YARA-X in staging, skips incompatible/slow files, and atomically activates the last-known-good set. See `docs/YARA_RULES_FEED.md`.
|
||||
|
||||
### Root Guard
|
||||
|
||||
On rooted devices BastionGuard can optionally use explicitly granted root access for deeper,
|
||||
read-only self-protection diagnostics. It detects signer changes, disabled critical components,
|
||||
runtime instrumentation, tracer attachment, SELinux weakening and writable protected mounts. Root
|
||||
access is never requested silently and is not used to hide the app, prevent uninstall or weaken
|
||||
Android security controls.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
BastionGuard™ Endpoint for Android is free software licensed under the **GNU General Public License version 3 (GPLv3)**.
|
||||
|
||||
You are free to use, study, modify and redistribute the software under the terms of the GNU GPLv3. Any redistribution or derivative work must comply with the obligations of that license.
|
||||
|
||||
Copyright © 2026 Calogero Scarnà.
|
||||
|
||||
See `LICENSE` for the complete license text.
|
||||
|
||||
Third-party components, libraries, signature sources and other external dependencies included or referenced by this project remain subject to their respective licenses, copyright notices and terms.
|
||||
|
||||
## Branding and trademarks
|
||||
|
||||
The GNU GPLv3 applies to the software source code. It does **not** grant any trademark rights in the **BastionGuard™** name, **BastionGuard™ Endpoint** product name, logos, icons, visual identity or associated branding.
|
||||
|
||||
Modified versions and independent redistributions must not be presented as official BastionGuard releases, must not imply endorsement or affiliation, and should use distinct naming and branding unless explicit permission has been granted.
|
||||
|
||||
References to BastionGuard may be used where reasonably necessary to describe the origin, compatibility or derivation of the software, provided that such use does not imply official status or endorsement.
|
||||
|
||||
Official BastionGuard builds are those distributed through channels explicitly identified by the BastionGuard project.
|
||||
|
||||
See `TRADEMARK.md` for the project trademark and branding policy.
|
||||
|
||||
## Release / Google Play
|
||||
|
||||
Per una release firmata usa `./build-release.sh`; produce APK + Android App Bundle in `dist/` e richiama automaticamente `./verify-release.sh`. Le credenziali di firma sono lette solo dalle variabili `BG_KEYSTORE_FILE`, `BG_KEYSTORE_PASSWORD`, `BG_KEY_ALIAS` e `BG_KEY_PASSWORD`. Dettagli: `docs/RELEASE_SIGNING.md` e `docs/PLAY_STORE_RELEASE.md`.
|
||||
99
SECURITY.md
Normal file
99
SECURITY.md
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
# Security Policy
|
||||
|
||||
## Reporting Vulnerabilities
|
||||
|
||||
The Bastionguard project takes security issues seriously and is committed
|
||||
to responsible vulnerability handling.
|
||||
|
||||
We encourage responsible disclosure of any security weakness that may
|
||||
impact the confidentiality, integrity, or availability of the system.
|
||||
|
||||
This includes, but is not limited to:
|
||||
|
||||
- Cryptographic weaknesses or key compromise
|
||||
- Authentication or authorization bypass
|
||||
- Remote code execution
|
||||
- Privilege escalation
|
||||
- Data leakage
|
||||
- Denial of Service vulnerabilities
|
||||
- Insecure default configurations
|
||||
|
||||
---
|
||||
|
||||
## Reporting Process
|
||||
|
||||
Security issues must be reported privately and must not be disclosed
|
||||
publicly before a fix or mitigation is available.
|
||||
|
||||
Please contact the security team using one of the following channels:
|
||||
|
||||
- **Email:** info@bastionguard.eu
|
||||
- **PGP Fingerprint:** E33B 4BC4 CAC6 FA6F 1CCA 2397 68D0 8974 A276 CF8A
|
||||
|
||||
Encrypted communication is strongly preferred.
|
||||
|
||||
---
|
||||
|
||||
## Report Requirements
|
||||
|
||||
To ensure efficient analysis, reports should include:
|
||||
|
||||
- A detailed description of the vulnerability
|
||||
- Affected versions and components
|
||||
- Steps to reproduce the issue
|
||||
- Proof of concept, when available
|
||||
- Potential impact assessment
|
||||
|
||||
Incomplete or unverifiable reports may not be prioritized.
|
||||
|
||||
---
|
||||
|
||||
## Responsible Disclosure
|
||||
|
||||
Reporters are expected to:
|
||||
|
||||
- Allow reasonable time for investigation and remediation
|
||||
- Avoid exploiting the vulnerability beyond proof of concept
|
||||
- Refrain from public disclosure until coordinated with maintainers
|
||||
|
||||
The project commits to:
|
||||
|
||||
- Acknowledge valid reports in a timely manner
|
||||
- Provide status updates when appropriate
|
||||
- Credit reporters, upon request
|
||||
|
||||
---
|
||||
|
||||
## Legal Safe Harbor
|
||||
|
||||
The Bastionguard project considers security research conducted in good faith
|
||||
and in accordance with this policy to be authorized.
|
||||
|
||||
We will not pursue legal action against researchers who:
|
||||
|
||||
- Act in good faith
|
||||
- Avoid privacy violations and service disruption
|
||||
- Respect this disclosure process
|
||||
- Do not exploit vulnerabilities for personal gain
|
||||
|
||||
---
|
||||
|
||||
## Scope
|
||||
|
||||
This policy applies to:
|
||||
|
||||
- Core platform components
|
||||
- Official plugins and extensions
|
||||
- Deployment scripts and configuration templates
|
||||
- Official documentation and tooling
|
||||
|
||||
Third-party integrations are excluded unless explicitly stated.
|
||||
|
||||
---
|
||||
|
||||
## Policy Updates
|
||||
|
||||
This Security Policy may be updated to reflect technical,
|
||||
legal, or operational changes.
|
||||
|
||||
All updates will be published in this repository.
|
||||
45
TRADEMARK.md
Normal file
45
TRADEMARK.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
# BastionGuard Trademark Policy
|
||||
|
||||
## Code License
|
||||
|
||||
The BastionGuard source code is released under the
|
||||
GNU General Public License version 3 (GPLv3).
|
||||
|
||||
This applies only to the software source code.
|
||||
|
||||
## Excluded from GPLv3
|
||||
|
||||
The following are NOT licensed under the GPLv3:
|
||||
|
||||
- The BastionGuard™ name
|
||||
- Logos, icons, and visual identity
|
||||
- Branding, slogans, and marketing materials
|
||||
- Any use implying official affiliation or endorsement
|
||||
|
||||
These elements are protected as trademarks and/or proprietary assets.
|
||||
|
||||
## Forks and Redistributions
|
||||
|
||||
You may fork and redistribute the software under the GPLv3 provided that:
|
||||
|
||||
- The GPLv3 terms are fully respected
|
||||
- Modifications are clearly stated
|
||||
- The BastionGuard™ name is not used in a misleading way
|
||||
|
||||
Redistributions must not present themselves as official releases
|
||||
without explicit authorization.
|
||||
|
||||
## No Endorsement
|
||||
|
||||
Use of the BastionGuard source code does not imply endorsement,
|
||||
sponsorship, or affiliation.
|
||||
|
||||
## Warranty Disclaimer
|
||||
|
||||
The software is provided "as is", without any warranty.
|
||||
|
||||
## Contact
|
||||
|
||||
For licensing and trademark inquiries:
|
||||
|
||||
info@bastionguard.eu
|
||||
Loading…
Add table
Add a link
Reference in a new issue