-
Notifications
You must be signed in to change notification settings - Fork 279
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
I Translate Readme File To Turkish For Turkish Developers Signed-off-by: dorukdogular <[email protected]>
- Loading branch information
1 parent
4aa7b1c
commit dc1a27b
Showing
1 changed file
with
91 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,163 +1,159 @@ | ||
[![CI](https://github.com/opensearch-project/security/workflows/CI/badge.svg?branch=main)](https://github.com/opensearch-project/security/actions) [![](https://img.shields.io/github/issues/opensearch-project/security/untriaged?labelColor=red)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"untriaged") [![](https://img.shields.io/github/issues/opensearch-project/security/security%20vulnerability?labelColor=red)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"security%20vulnerability") [![](https://img.shields.io/github/issues/opensearch-project/security)](https://github.com/opensearch-project/security/issues) [![](https://img.shields.io/github/issues-pr/opensearch-project/security)](https://github.com/opensearch-project/security/pulls) | ||
[![](https://img.shields.io/codecov/c/gh/opensearch-project/security)](https://app.codecov.io/gh/opensearch-project/security) [![](https://img.shields.io/github/issues/opensearch-project/security/v2.18.0)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"v2.18.0") [![](https://img.shields.io/github/issues/opensearch-project/security/v3.0.0)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"v3.0.0") | ||
[![CI](https://github.com/opensearch-project/security/workflows/CI/badge.svg?branch=main)](https://github.com/opensearch-project/security/actions) [![](https://img.shields.io/github/issues/opensearch-project/security/untriaged?labelColor=red)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"untriaged") [![](https://img.shields.io/github/issues/opensearch-project/security/security%20vulnerability?labelColor=red)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"security%20vulnerability") [![](https://img.shields.io/github/issues/opensearch-project/security)](https://github.com/opensearch-project/security/issues) [![](https://img.shields.io/github/issues-pr/opensearch-project/security)](https://github.com/opensearch-project/security/pulls) [![](https://img.shiel) ds.io/codecov/c/gh/opensearch-project/security)](https://app.codecov.io/gh/opensearch-project/security) [![](https://img.shields.io/github/issues/opensearch-project/security/v2.18.0)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A "v2.18.0") [![](https://img.shields.io/github/issues/opensearch-project/security/v3.0.0)](https://github.com/opensearch-project/security/issues?q=is%3Aissue+is%3Aopen+label%3A"v3.0.0") | ||
[![Slack](https://img.shields.io/badge/Slack-4A154B?&logo=slack&logoColor=white)](https://opensearch.slack.com/archives/C051Y637FKK) | ||
|
||
|
||
|
||
## Announcement: The Slack workspace is live! Please join the [conversation](https://opensearch.slack.com/archives/C051Y637FKK). | ||
## Duyuru: Slack çalışma alanı yayında! Lütfen [sohbete](https://opensearch.slack.com/archives/C051Y637FKK) katılın. | ||
|
||
<img src="https://opensearch.org/assets/img/opensearch-logo-themed.svg" height="64px"> | ||
|
||
# OpenSearch Security Plugin | ||
|
||
OpenSearch Security is a plugin for OpenSearch that offers encryption, authentication and authorization. When combined with OpenSearch Security-Advanced Modules, it supports authentication via Active Directory, LDAP, Kerberos, JSON web tokens, SAML, OpenID and more. It includes fine grained role-based access control to indices, documents and fields. It also provides multi-tenancy support in OpenSearch Dashboards. | ||
|
||
- [OpenSearch Security Plugin](#opensearch-security-plugin) | ||
- [Features](#features) | ||
- [Encryption](#encryption) | ||
- [Authentication](#authentication) | ||
- [Access control](#access-control) | ||
- [Audit/Compliance logging](#auditcompliance-logging) | ||
- [OpenSearch Dashboards multi-tenancy](#opensearch-dashboards-multi-tenancy) | ||
- [Installation](#installation) | ||
- [Test and Build](#test-and-build) | ||
- [Config hot reloading](#config-hot-reloading) | ||
- [Onboarding new APIs](#onboarding-new-apis) | ||
- [System Index Protection](#system-index-protection) | ||
- [Contributing](#contributing) | ||
- [Getting Help](#getting-help) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [Security](#security) | ||
- [License](#license) | ||
- [Copyright](#copyright) | ||
|
||
## Features | ||
|
||
### Encryption | ||
* Full data in transit encryption | ||
* Node-to-node encryption | ||
* Certificate revocation lists | ||
* Hot Certificate renewal | ||
|
||
### Authentication | ||
* Internal user database | ||
* HTTP basic authentication | ||
* PKI authentication | ||
* Proxy authentication | ||
* User Impersonation | ||
# OpenSearch Güvenlik Eklentisi | ||
|
||
OpenSearch Güvenliği, şifreleme, kimlik doğrulama ve yetkilendirme sunan bir OpenSearch eklentisidir. OpenSearch Security-Advanced Modülleri ile birleştirildiğinde, Active Directory, LDAP, Kerberos, JSON web belirteçleri, SAML, OpenID ve daha fazlası aracılığıyla kimlik doğrulamayı destekler. Dizinlere, belgelere ve alanlara ince ayrıntılı rol tabanlı erişim denetimi içerir. Ayrıca OpenSearch Panolarında çoklu kiracı desteği sağlar. | ||
|
||
- [OpenSearch Güvenlik Eklentisi](#opensearch-security-plugin) | ||
- [Özellikler](#özellikler) | ||
- [Şifreleme](#şifreleme) | ||
- [Kimlik Doğrulama](#kimlik doğrulama) | ||
- [Erişim denetimi](#erişim denetimi) | ||
- [Denetim/Uyumluluk kaydı](#auditcompliance-logging) | ||
- [OpenSearch Panoları çoklu kiracı](#opensearch-dashboards-çoklu kiracı) | ||
- [Kurulum](#kurulum) | ||
- [Test ve Derleme](#test-and-build) | ||
- [Sıcak yeniden yüklemeyi yapılandır](#config-hot-reloading) | ||
- [Yeni API'leri yerleştirme](#onboarding-new-apis) | ||
- [Sistem Dizin Koruması](#system-index-protection) | ||
- [Katkıda Bulunma](#contributing) | ||
- [Alma Yardım](#getting-help) | ||
- [Davranış Kuralları](#davranış-kuralları) | ||
- [Güvenlik](#güvenlik) | ||
- [Lisans](#lisans) | ||
- [Telif Hakkı](#telif hakkı) | ||
|
||
## Özellikler | ||
|
||
### Şifreleme | ||
* Transit sırasında tam veri şifrelemesi | ||
* Düğümler arası şifreleme | ||
* Sertifika iptal listeleri | ||
* Sıcak Sertifika yenileme | ||
|
||
### Kimlik doğrulama | ||
* Dahili kullanıcı veritabanı | ||
* HTTP temel kimlik doğrulaması | ||
* PKI kimlik doğrulaması | ||
* Proxy kimlik doğrulaması | ||
* Kullanıcı Kimliğine Bürünme | ||
* Active Directory / LDAP | ||
* Kerberos / SPNEGO | ||
* JSON web token (JWT) | ||
* JSON web belirteci (JWT) | ||
* OpenID Connect (OIDC) | ||
* SAML | ||
|
||
### Access control | ||
* Role-based cluster level access control | ||
* Role-based index level access control | ||
* User-, role- and permission management | ||
* Document-level security | ||
* Field-level security | ||
* REST management API | ||
### Erişim denetimi | ||
* Rol tabanlı küme düzeyinde erişim denetimi | ||
* Rol tabanlı dizin düzeyinde erişim denetimi | ||
* Kullanıcı, rol ve izin yönetimi | ||
* Belge düzeyinde güvenlik | ||
* Alan düzeyinde güvenlik | ||
* REST yönetim API'si | ||
|
||
### Audit/Compliance logging | ||
* Audit logging | ||
* Compliance logging for GDPR, HIPAA, PCI, SOX and ISO compliance | ||
### Denetim/Uyumluluk günlük kaydı | ||
* Denetim günlüğü | ||
* GDPR, HIPAA, PCI, SOX ve ISO uyumluluğu için uyumluluk günlüğü | ||
|
||
### OpenSearch Dashboards multi-tenancy | ||
* True OpenSearch Dashboards multi-tenancy | ||
### OpenSearch Panoları çoklu kiracı | ||
* Gerçek OpenSearch Panoları çoklu kiracı | ||
|
||
## Installation | ||
## Kurulum | ||
|
||
OpenSearch Security Plugin comes bundled by default as part of the OpenSearch distribution. Please refer to the [installation guide](https://opensearch.org/docs/latest/opensearch/install/index/) and [technical documentation](https://opensearch.org/docs/latest/security-plugin/index/) for detailed information on installing and configuring the OpenSearch Security Plugin. | ||
OpenSearch Güvenlik Eklentisi varsayılan olarak OpenSearch dağıtımının bir parçası olarak birlikte gelir. OpenSearch Güvenlik Eklentisini yükleme ve yapılandırma hakkında ayrıntılı bilgi için lütfen [kurulum kılavuzuna](https://opensearch.org/docs/latest/opensearch/install/index/) ve [teknik belgelere](https://opensearch.org/docs/latest/security-plugin/index/) bakın. | ||
|
||
You can also see the [developer guide](https://github.com/opensearch-project/security/blob/main/DEVELOPER_GUIDE.md) which walks through the installation of the plugin for an OpenSearch server that doesn't initially have it. | ||
Ayrıca, başlangıçta eklentiye sahip olmayan bir OpenSearch sunucusu için eklentinin kurulumunu adım adım açıklayan [geliştirici kılavuzuna](https://github.com/opensearch-project/security/blob/main/DEVELOPER_GUIDE.md) da bakabilirsiniz. | ||
|
||
## Test and Build | ||
## Test ve Oluşturma | ||
|
||
Run all tests: | ||
Tüm testleri çalıştırın: | ||
```bash | ||
./gradlew clean test | ||
``` | ||
|
||
Run tests against local cluster: | ||
Testleri yerel kümeye karşı çalıştırın: | ||
```bash | ||
./gradlew integTestRemote -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername=docker-cluster -Dsecurity=true -Dhttps=true -Duser=admin -Dpassword=admin -Dcommon_utils.version="2.2.0.0" | ||
``` | ||
OR | ||
VEYA | ||
```bash | ||
./scripts/integtest.sh | ||
``` | ||
Note: To run against a remote cluster replace cluster-name and `localhost:9200` with the IPAddress:Port of that cluster. | ||
Not: Uzak bir kümeye karşı çalıştırmak için cluster-name ve `localhost:9200` öğelerini o kümenin IPAddress:Port'uyla değiştirin. | ||
|
||
Build artifacts (zip, deb, rpm): | ||
Yapıtları derle (zip, deb, rpm): | ||
```bash | ||
./gradlew clean assemble | ||
./gradlew clean assembly | ||
artifact_zip=`ls $(pwd)/build/distributions/opensearch-security-*.zip | grep -v admin-standalone` | ||
./gradlew buildDeb buildRpm -ParchivePath=$artifact_zip | ||
``` | ||
|
||
This produces: | ||
Bu şunu üretir: | ||
|
||
``` | ||
build/releases/opensearch-security-<VERSION>.zip | ||
build/distributions/opensearch-security-<VERSION>.deb | ||
build/distributions/opensearch-security-<VERSION>.rpm | ||
``` | ||
|
||
## Config hot reloading | ||
## Yapılandırma sıcak yeniden yükleme | ||
|
||
The Security Plugin configuration is stored in a dedicated index in OpenSearch itself. Changes to the configuration are pushed to this index via the command line tool. This triggers a reload of the configuration on all nodes automatically. This has several advantages over configuration via `opensearch.yml`: | ||
Güvenlik Eklentisi yapılandırması OpenSearch'ün kendisinde özel bir dizinde saklanır. Yapılandırmadaki değişiklikler komut satırı aracı aracılığıyla bu dizine gönderilir. Bu, tüm düğümlerde yapılandırmanın otomatik olarak yeniden yüklenmesini tetikler. Bunun `opensearch.yml` aracılığıyla yapılandırmaya göre birkaç avantajı vardır: | ||
|
||
* Configuration is stored in a central place | ||
* No configuration files on the nodes necessary | ||
* Configuration changes do not require a restart | ||
* Configuration changes take effect immediately | ||
* Yapılandırma merkezi bir yerde saklanır | ||
* Düğümlerde yapılandırma dosyası gerekmez | ||
* Yapılandırma değişiklikleri yeniden başlatma gerektirmez | ||
* Yapılandırma değişiklikleri hemen etkili olur | ||
|
||
## Onboarding new APIs | ||
## Yeni API'leri dahil etme | ||
|
||
It is common practice to create new transport actions to perform different tasks between nodes when developing new APIs. For any new or existing plugins that want to onboard & integrate these actions with security, they should follow the steps below: | ||
1. Name your action ([example](https://github.com/opensearch-project/anomaly-detection/blob/main/src/main/java/org/opensearch/ad/transport/SearchADTasksAction.java#L35)), and register it ([example](https://github.com/opensearch-project/anomaly-detection/blob/main/src/main/java/org/opensearch/ad/AnomalyDetectorPlugin.java#L935)) in your plugin. Best practice is to follow existing naming conventions, which follow a hierarchical pattern to keep the action names organized between different plugins. | ||
2. Register the action in the [OpenSearch Security plugin](https://github.com/opensearch-project/security). Each new action is registered in the plugin as a new permission. Usually, plugins will define different roles for their plugin (e.g., read-only access, write access). Each role will contain a set of permissions. An example of adding a new permission to the `anomaly_read_access` role for the [Anomaly Detection plugin](https://github.com/opensearch-project/anomaly-detection) can be found in [this PR](https://github.com/opensearch-project/security/pull/997/files). | ||
3. Register the action in the [OpenSearch Dashboards Security plugin](https://github.com/opensearch-project/security-dashboards-plugin). This plugin maintains the full list of possible permissions, so users can see all of them when creating new roles or searching permissions via Dashboards. An example of adding different permissions can be found in [this PR](https://github.com/opensearch-project/security-dashboards-plugin/pull/689/files). | ||
Yeni API'ler geliştirirken düğümler arasında farklı görevler gerçekleştirmek için yeni taşıma eylemleri oluşturmak yaygın bir uygulamadır. Bu eylemleri güvenlikle entegre etmek ve entegre etmek isteyen yeni veya mevcut eklentiler için aşağıdaki adımları izlemeleri gerekir: | ||
1. Eyleminize bir ad verin ([örnek](https://github.com/opensearch-project/anomaly-detection/blob/main/src/main/java/org/opensearch/ad/transport/SearchADTasksAction.java#L35)) ve eklentinizde kaydedin ([örnek](https://github.com/opensearch-project/anomaly-detection/blob/main/src/main/java/org/opensearch/ad/AnomalyDetectorPlugin.java#L935)). En iyi uygulama, eylem adlarını farklı eklentiler arasında düzenli tutmak için hiyerarşik bir desen izleyen mevcut adlandırma kurallarını takip etmektir. | ||
2. Eylemi [OpenSearch Güvenlik eklentisine](https://github.com/opensearch-project/security) kaydedin. Her yeni eylem eklentide yeni bir izin olarak kaydedilir. Genellikle eklentiler eklentileri için farklı roller tanımlar (örneğin salt okunur erişim, yazma erişimi). Her rol bir izin kümesi içerir. [Anomaly Detection eklentisi](https://github.com/opensearch-project/anomaly-detection) için `anomaly_read_access` rolüne yeni bir izin eklemenin bir örneği [bu PR'de](https://github.com/opensearch-project/security/pull/997/files) bulunabilir. | ||
3. Eylemi [OpenSearch Dashboards Security eklentisinde](https://github.com/opensearch-project/security-dashboards-plugin) kaydedin. Bu eklenti olası izinlerin tam listesini korur, böylece kullanıcılar yeni roller oluştururken veya Dashboard'lar aracılığıyla izinleri ararken bunların hepsini görebilir. Farklı izinler eklemenin bir örneği [bu PR'de](https://github.com/opensearch-project/security-dashboards-plugin/pull/689/files) bulunabilir. | ||
|
||
See the [plugin-authorization-flows](ARCHITECTURE.md#plugin-authorization-flows) in the ARCHITECTURE.md. | ||
ARCHITECTURE.md'deki [plugin-authorization-flows](ARCHITECTURE.md#plugin-authorization-flows)'a bakın. | ||
|
||
### System Index Protection | ||
### Sistem Dizin Koruması | ||
|
||
The Security Plugin provides protection to system indices used by plugins. The system index names must be explicitly registered in `opensearch.yml` under the `plugins.security.system_indices.indices` setting. See below for an example setup of system index protection from the demo configuration: | ||
Güvenlik Eklentisi, eklentiler tarafından kullanılan sistem dizinlerine koruma sağlar. Sistem dizin adları, `plugins.security.system_indices.indices` ayarı altında `opensearch.yml`'de açıkça kaydedilmelidir. Demo yapılandırmasından sistem dizin korumasının örnek kurulumu için aşağıya bakın: | ||
|
||
``` | ||
plugins.security.system_indices.enabled: true | ||
plugins.security.system_indices.indices: [".plugins-ml-model", ".plugins-ml-task", ".opendistro-alerting-config", ".opendistro-alerting-alert*", ".opendistro-anomaly-results*", ".opendistro-anomaly-detector*", ".opendistro-anomaly-checkpoints", ".opendistro-anomaly-detection-state", ".opendistro-reports-*", ".opensearch-notifications-*", ".opensearch-notebooks", ".opensearch-observability", ".opendistro-asynchronous-search-response*", ".replication-metadata-store"] | ||
``` | ||
|
||
The demo configuration can be modified in the following files to add a new system index to the demo configuration: | ||
Demo yapılandırması, demo yapılandırmasına yeni bir sistem dizini eklemek için aşağıdaki dosyalarda değiştirilebilir: | ||
|
||
- https://github.com/opensearch-project/security/blob/main/src/main/java/org/opensearch/security/tools/democonfig/SecuritySettingsConfigurer.java | ||
|
||
## Katkıda Bulunma | ||
|
||
## Contributing | ||
|
||
See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md). | ||
Bkz. [geliştirici kılavuzu](DEVELOPER_GUIDE.md) ve [bu projeye nasıl katkıda bulunulur](CONTRIBUTING.md). | ||
|
||
## Getting Help | ||
## Yardım Alma | ||
|
||
If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository. | ||
Bir hata bulursanız veya bir özellik isteğiniz varsa, lütfen bu depoda bir sorun açmaktan çekinmeyin. | ||
|
||
For more information, see [project website](https://opensearch.org/) and [documentation](https://opensearch.org/docs/latest). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/). | ||
Daha fazla bilgi için [proje web sitesi](https://opensearch.org/) ve [belgeler](https://opensearch.org/docs/latest) bölümüne bakın. Yardıma ihtiyacınız varsa ve bir sorunu nerede açacağınızdan emin değilseniz [forumları](https://discuss.opendistrocommunity.dev/) deneyin. | ||
|
||
## Code of Conduct | ||
## Davranış Kuralları | ||
|
||
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
Bu proje [Amazon Açık Kaynak Davranış Kuralları](CODE_OF_CONDUCT.md)'nı benimsemiştir. Daha fazla bilgi için [Davranış Kuralları SSS](https://aws.github.io/code-of-conduct-faq)'na bakın veya ek sorularınız veya yorumlarınız için [[email protected]](mailto:[email protected]) ile iletişime geçin. | ||
|
||
## Security | ||
## Güvenlik | ||
|
||
If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to [email protected]. Please do **not** create a public GitHub issue. | ||
Bu projede olası bir güvenlik sorunu keşfederseniz, lütfen OpenSearch Security'yi doğrudan [email protected] adresine e-posta göndererek bilgilendirmenizi rica ederiz. Lütfen genel bir GitHub sorunu **oluşturmayın**. | ||
|
||
## License | ||
## Lisans | ||
|
||
This code is licensed under the Apache 2.0 License. | ||
Bu kod Apache 2.0 Lisansı altında lisanslanmıştır. | ||
|
||
## Copyright | ||
## Telif Hakkı | ||
|
||
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details. | ||
Telif Hakkı OpenSearch Katkıda Bulunanlara aittir. Ayrıntılar için [NOTICE](NOTICE.txt) dosyasına bakın. |