|
| 1 | +# bee2go |
| 2 | + |
| 3 | +Go-обертки для [bee2](https://github.com/agievich/bee2) — C-реализации белорусских криптографических стандартов. |
| 4 | + |
| 5 | +Пакет предоставляет высокоуровневые обертки для: |
| 6 | +- `bash`: хеш и псевдослучайный генератор |
| 7 | +- `belt`: хеш, блочные режимы, MAC, AEAD, HMAC, PBKDF2 и обертка ключей |
| 8 | +- `bign`: параметры, генерация ключей, DH, подписи, транспорт ключей и подписи на основе идентичности |
| 9 | +- `bake`: аутентифицированная выработка ключа BSTS |
| 10 | +- `brng`: детерминированные генераторы случайных данных |
| 11 | + |
| 12 | +## Требования |
| 13 | + |
| 14 | +- Go 1.22+ |
| 15 | +- Тулчейн C-компилятора |
| 16 | +- CMake |
| 17 | +- Исходники `bee2` доступны как git submodule в `./bee2` |
| 18 | + |
| 19 | +## Быстрый старт |
| 20 | + |
| 21 | +### 1. Клонирование |
| 22 | + |
| 23 | +```bash |
| 24 | +git clone --recurse-submodules https://github.com/miniusercoder/bee2go.git |
| 25 | +cd bee2go |
| 26 | +``` |
| 27 | + |
| 28 | +Если репозиторий уже был клонирован без submodule: |
| 29 | + |
| 30 | +```bash |
| 31 | +git submodule update --init --recursive |
| 32 | +``` |
| 33 | + |
| 34 | +### 2. Установил-запустил (одной командой) |
| 35 | + |
| 36 | +```bash |
| 37 | +make setup |
| 38 | +make run |
| 39 | +``` |
| 40 | + |
| 41 | +Это: |
| 42 | +- подтянет submodule, |
| 43 | +- соберет статическую библиотеку `bee2`, |
| 44 | +- запустит демонстрационное приложение `cmd/demo`. |
| 45 | + |
| 46 | +### 3. Запуск тестов |
| 47 | + |
| 48 | +```bash |
| 49 | +make test |
| 50 | +``` |
| 51 | + |
| 52 | +### 4. Ручной режим (без Makefile) |
| 53 | + |
| 54 | +Сборка статической библиотеки bee2: |
| 55 | + |
| 56 | +```bash |
| 57 | +bash scripts/build_bee2.sh |
| 58 | +``` |
| 59 | + |
| 60 | +Запуск тестов: |
| 61 | + |
| 62 | +```bash |
| 63 | +go test ./... -v |
| 64 | +``` |
| 65 | + |
| 66 | +## Установка |
| 67 | + |
| 68 | +Текущий поддерживаемый формат установки: работа из исходников репозитория с локальной сборкой `bee2`. |
| 69 | + |
| 70 | +Используйте шаги из раздела «Быстрый старт»: |
| 71 | +- `make setup` |
| 72 | +- `make run` |
| 73 | +- `make test` |
| 74 | + |
| 75 | +## Команды Makefile |
| 76 | + |
| 77 | +- `make setup` — подготовить проект к работе |
| 78 | +- `make run` — запустить demo (`cmd/demo`) |
| 79 | +- `make test` — запустить все тесты |
| 80 | +- `make clean` — удалить артефакты сборки `bee2/build` |
| 81 | + |
| 82 | +## Использование |
| 83 | + |
| 84 | +### Рекомендуемый UX для сторонних разработчиков: Go Workspace (`go work`) |
| 85 | + |
| 86 | +Этот вариант не требует правок `go.mod` вашего приложения и удобен для локальной разработки. |
| 87 | + |
| 88 | +1. Разместите ваш проект и `bee2go` рядом: |
| 89 | + |
| 90 | +```text |
| 91 | +workspace/ |
| 92 | + my-app/ |
| 93 | + bee2go/ |
| 94 | +``` |
| 95 | + |
| 96 | +2. Подготовьте `bee2go`: |
| 97 | + |
| 98 | +```bash |
| 99 | +cd bee2go |
| 100 | +make setup |
| 101 | +``` |
| 102 | + |
| 103 | +3. Создайте workspace из каталога приложения: |
| 104 | + |
| 105 | +```bash |
| 106 | +cd ../my-app |
| 107 | +go work init . ../bee2go |
| 108 | +``` |
| 109 | + |
| 110 | +4. Добавьте импорт в коде приложения: |
| 111 | + |
| 112 | +```go |
| 113 | +import "github.com/miniusercoder/bee2go" |
| 114 | +``` |
| 115 | + |
| 116 | +5. Минимальный пример использования (belt-hash): |
| 117 | + |
| 118 | +```go |
| 119 | +package main |
| 120 | + |
| 121 | +import ( |
| 122 | + "fmt" |
| 123 | + "log" |
| 124 | + |
| 125 | + "github.com/miniusercoder/bee2go" |
| 126 | +) |
| 127 | + |
| 128 | +func main() { |
| 129 | + digest, err := bee2go.BeltHash([]byte("hello")) |
| 130 | + if err != nil { |
| 131 | + log.Fatal(err) |
| 132 | + } |
| 133 | + fmt.Printf("belt-hash: %X\n", digest) |
| 134 | +} |
| 135 | +``` |
| 136 | + |
| 137 | +6. Запустите приложение обычной командой `go run` или `go build`. |
| 138 | + |
| 139 | +## Стратегия тестирования |
| 140 | + |
| 141 | +В репозитории есть: |
| 142 | +- тесты с известными ответами (KAT), полученные из векторов upstream `bee2` |
| 143 | +- round-trip тесты для API шифрования/дешифрования и wrap/unwrap |
| 144 | +- тесты порчи данных и негативных сценариев для проверки аутентичности и подписей |
| 145 | +- тесты валидации аргументов: nil, размерные и форматные ограничения |
| 146 | +- интеграционные тесты для выработки ключа BSTS |
| 147 | + |
| 148 | +## CI |
| 149 | + |
| 150 | +Workflow GitHub Actions: |
| 151 | +- выполняет checkout репозитория с submodule |
| 152 | +- собирает статическую библиотеку `bee2` |
| 153 | +- запускает `go vet ./...` |
| 154 | +- запускает `make test` |
| 155 | + |
| 156 | +См. `.github/workflows/ci.yml`. |
| 157 | + |
| 158 | +## Замечания по безопасности |
| 159 | + |
| 160 | +- Большинство объектов-оберток хранят нативное C-состояние и небезопасны для конкурентного использования из нескольких goroutine. |
| 161 | +- Всегда вызывайте `Free()` для долгоживущих объектов, выделяющих память в C. |
| 162 | +- Не используйте демонстрационные ключи из примеров в production. |
| 163 | + |
| 164 | +## Лицензия |
| 165 | + |
| 166 | +Проект распространяется по лицензии, указанной в `LICENCE`. |
0 commit comments