Skip to content

Commit f48dbe7

Browse files
committed
docs: refresh security docs and fork references
Update the STS, security, select, and Docker documentation to reflect the recent hardening work, including LDAP STS throttling details, OIDC JWT verification changes, and the new pgsty-specific security policy and advisory index. Rewrite repository and raw-document links that still pointed at minio/minio so the docs consistently reference pgsty/minio instead. The core idea is to keep the documentation aligned with the fork's actual security behavior, ownership, and upgrade guidance without mixing in unrelated code changes.
1 parent f441108 commit f48dbe7

44 files changed

Lines changed: 203 additions & 163 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Docker Image](https://img.shields.io/badge/Docker-pgsty/minio-%232496ED?style=flat&logo=docker&logoColor=white)](https://hub.docker.com/r/pgsty/minio)
99

1010
> [!IMPORTANT]
11-
> **This is a community-maintained fork of [minio/minio](https://github.com/minio/minio), maintained by [Pigsty](https://pigsty.io).**
11+
> **This is a community-maintained fork of the upstream MinIO project, maintained by [Pigsty](https://pigsty.io).**
1212
> This project is **NOT** affiliated with, endorsed by, or sponsored by MinIO, Inc.
1313
> "MinIO" is a trademark of MinIO, Inc., used here solely to identify the upstream project.
1414
>
@@ -29,4 +29,3 @@ Console: [`georgmangold/console`](https://github.com/georgmangold/console/), a c
2929
Ansible Deployment: [https://pigsty.io/docs/minio](https://pigsty.io/docs/minio)
3030

3131
APT/YUM repo for `minio` and `mcli` binary: [https://pigsty.io/docs/infra](https://pigsty.io/docs/repo/infra/list/#object-storage)
32-

SECURITY.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,20 @@
11
# Security Policy
22

3+
This repository is the `pgsty/minio` community fork of `minio/minio`. Upstream MinIO security contacts do not handle fork-specific fixes or release notes for this repository.
4+
35
## Supported Versions
46

5-
We always provide security updates for the [latest release](https://github.com/minio/minio/releases/latest).
6-
Whenever there is a security update you just need to upgrade to the latest version.
7+
Security fixes are tracked on the active `master` branch and summarized in [docs/security/advisories.md](docs/security/advisories.md).
78

89
## Reporting a Vulnerability
910

10-
All security bugs in [minio/minio](https://github,com/minio/minio) (or other minio/* repositories)
11-
should be reported by email to security@min.io. Your email will be acknowledged within 48 hours,
12-
and you'll receive a more detailed response to your email within 72 hours indicating the next steps
13-
in handling your report.
14-
15-
Please, provide a detailed explanation of the issue. In particular, outline the type of the security
16-
issue (DoS, authentication bypass, information disclose, ...) and the assumptions you're making (e.g. do
17-
you need access credentials for a successful exploit).
18-
19-
If you have not received a reply to your email within 48 hours or you have not heard from the security team
20-
for the past five days please contact the security team directly:
21-
22-
- Primary security coordinator: aead@min.io
23-
- Secondary coordinator: harsha@min.io
24-
- If you receive no response: dev@min.io
25-
26-
### Disclosure Process
11+
For vulnerabilities in this fork:
2712

28-
MinIO uses the following disclosure process:
13+
1. Follow the fork-specific expectations in [VULNERABILITY_REPORT.md](VULNERABILITY_REPORT.md).
14+
2. Prefer the `pgsty/minio` repository's GitHub security reporting workflow when it is available.
15+
3. If private reporting is not available, contact the maintainers through the `pgsty/minio` repository before publishing detailed exploit information.
16+
4. If you confirm the issue also affects upstream `minio/minio`, report it upstream separately.
2917

30-
1. Once the security report is received one member of the security team tries to verify and reproduce
31-
the issue and determines the impact it has.
32-
2. A member of the security team will respond and either confirm or reject the security report.
33-
If the report is rejected the response explains why.
34-
3. Code is audited to find any potential similar problems.
35-
4. Fixes are prepared for the latest release.
36-
5. On the date that the fixes are applied a security advisory will be published on <https://blog.min.io>.
37-
Please inform us in your report email whether MinIO should mention your contribution w.r.t. fixing
38-
the security issue. By default MinIO will **not** publish this information to protect your privacy.
18+
## Disclosure Process
3919

40-
This process can take some time, especially when coordination is required with maintainers of other projects.
41-
Every effort will be made to handle the bug in as timely a manner as possible, however it's important that we
42-
follow the process described above to ensure that disclosures are handled consistently.
20+
Fork-specific fixes and user-visible upgrade notes are published in [docs/security/advisories.md](docs/security/advisories.md). The fork-specific triage and remediation process is described in [VULNERABILITY_REPORT.md](VULNERABILITY_REPORT.md).

VULNERABILITY_REPORT.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
11
# Vulnerability Management Policy
22

3-
This document formally describes the process of addressing and managing a
4-
reported vulnerability that has been found in the MinIO server code base,
5-
any directly connected ecosystem component or a direct / indirect dependency
6-
of the code base.
3+
This document describes how the `pgsty/minio` maintainers investigate,
4+
assess, and remediate reported vulnerabilities affecting this fork, any
5+
directly shipped component, or a direct / indirect dependency used by this
6+
repository.
77

88
## Scope
99

10-
The vulnerability management policy described in this document covers the
11-
process of investigating, assessing and resolving a vulnerability report
12-
opened by a MinIO employee or an external third party.
10+
This policy covers vulnerability reports opened by repository maintainers or
11+
external third parties against `pgsty/minio` itself, its release artifacts, or
12+
dependencies that materially affect this fork.
1313

14-
Therefore, it lists pre-conditions and actions that should be performed to
15-
resolve and fix a reported vulnerability.
14+
It defines the information needed for triage and the expected remediation
15+
workflow for supported fixes.
1616

1717
## Vulnerability Management Process
1818

19-
The vulnerability management process requires that the vulnerability report
20-
contains the following information:
19+
A useful vulnerability report should contain the following information:
2120

2221
- The project / component that contains the reported vulnerability.
2322
- A description of the vulnerability. In particular, the type of the
24-
reported vulnerability and how it might be exploited. Alternatively,
25-
a well-established vulnerability identifier, e.g. CVE number, can be
26-
used instead.
23+
reported vulnerability and how it might be exploited. Alternatively,
24+
a well-established vulnerability identifier, such as a CVE or GHSA ID, can
25+
be used instead.
2726

28-
Based on the description mentioned above, a MinIO engineer or security team
29-
member investigates:
27+
Based on the report, the `pgsty/minio` maintainers investigate:
3028

3129
- Whether the reported vulnerability exists.
3230
- The conditions that are required such that the vulnerability can be exploited.
31+
- Which releases, branches, or deployment paths are affected.
3332
- The steps required to fix the vulnerability.
3433

35-
In general, if the vulnerability exists in one of the MinIO code bases
36-
itself - not in a code dependency - then MinIO will, if possible, fix
37-
the vulnerability or implement reasonable countermeasures such that the
38-
vulnerability cannot be exploited anymore.
34+
If the vulnerability exists in this fork itself, the maintainers will, when
35+
feasible, fix the issue or implement reasonable countermeasures such that the
36+
vulnerability can no longer be exploited. Fork-specific upgrade notes and
37+
security advisories are published in `docs/security/advisories.md`.

docs/bigdata/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## **1. Cloud-native Architecture**
44

5-
![cloud-native](https://github.com/minio/minio/blob/master/docs/bigdata/images/image1.png?raw=true "cloud native architecture")
5+
![cloud-native](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image1.png?raw=true "cloud native architecture")
66

77
Kubernetes manages stateless Spark and Hive containers elastically on the compute nodes. Spark has native scheduler integration with Kubernetes. Hive, for legacy reasons, uses YARN scheduler on top of Kubernetes.
88

@@ -23,17 +23,17 @@ MinIO also supports multi-cluster, multi-site federation similar to AWS regions
2323

2424
After successful installation navigate to the Ambari UI `http://<ambari-server>:8080/` and login using the default credentials: [**_username: admin, password: admin_**]
2525

26-
![ambari-login](https://github.com/minio/minio/blob/master/docs/bigdata/images/image3.png?raw=true "ambari login")
26+
![ambari-login](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image3.png?raw=true "ambari login")
2727

2828
### **3.1 Configure Hadoop**
2929

3030
Navigate to **Services** -> **HDFS** -> **CONFIGS** -> **ADVANCED** as shown below
3131

32-
![hdfs-configs](https://github.com/minio/minio/blob/master/docs/bigdata/images/image2.png?raw=true "hdfs advanced configs")
32+
![hdfs-configs](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image2.png?raw=true "hdfs advanced configs")
3333

3434
Navigate to **Custom core-site** to configure MinIO parameters for `_s3a_` connector
3535

36-
![s3a-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image5.png?raw=true "custom core-site")
36+
![s3a-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image5.png?raw=true "custom core-site")
3737

3838
```
3939
sudo pip install yq
@@ -100,17 +100,17 @@ The rest of the other optimization options are discussed in the links below
100100

101101
Once the config changes are applied, proceed to restart **Hadoop** services.
102102

103-
![hdfs-services](https://github.com/minio/minio/blob/master/docs/bigdata/images/image7.png?raw=true "hdfs restart services")
103+
![hdfs-services](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image7.png?raw=true "hdfs restart services")
104104

105105
### **3.2 Configure Spark2**
106106

107107
Navigate to **Services** -> **Spark2** -> **CONFIGS** as shown below
108108

109-
![spark-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image6.png?raw=true "spark config")
109+
![spark-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image6.png?raw=true "spark config")
110110

111111
Navigate to “**Custom spark-defaults**” to configure MinIO parameters for `_s3a_` connector
112112

113-
![spark-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image9.png?raw=true "spark defaults")
113+
![spark-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image9.png?raw=true "spark defaults")
114114

115115
Add the following optimal entries for _spark-defaults.conf_ to configure Spark with **MinIO**.
116116

@@ -146,17 +146,17 @@ spark.hadoop.fs.s3a.threads.max 2048 # maximum number of threads for S3A
146146

147147
Once the config changes are applied, proceed to restart **Spark** services.
148148

149-
![spark-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image12.png?raw=true "spark restart services")
149+
![spark-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image12.png?raw=true "spark restart services")
150150

151151
### **3.3 Configure Hive**
152152

153153
Navigate to **Services** -> **Hive** -> **CONFIGS**-> **ADVANCED** as shown below
154154

155-
![hive-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image10.png?raw=true "hive advanced config")
155+
![hive-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image10.png?raw=true "hive advanced config")
156156

157157
Navigate to “**Custom hive-site**” to configure MinIO parameters for `_s3a_` connector
158158

159-
![hive-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image11.png?raw=true "hive advanced config")
159+
![hive-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image11.png?raw=true "hive advanced config")
160160

161161
Add the following optimal entries for `hive-site.xml` to configure Hive with **MinIO**.
162162

@@ -171,11 +171,11 @@ mapreduce.input.fileinputformat.list-status.num-threads=50
171171

172172
For more information about these options please visit [https://www.cloudera.com/documentation/enterprise/5-11-x/topics/admin_hive_on_s3_tuning.html](https://www.cloudera.com/documentation/enterprise/5-11-x/topics/admin_hive_on_s3_tuning.html)
173173

174-
![hive-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image13.png?raw=true "hive advanced custom config")
174+
![hive-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image13.png?raw=true "hive advanced custom config")
175175

176176
Once the config changes are applied, proceed to restart all Hive services.
177177

178-
![hive-config](https://github.com/minio/minio/blob/master/docs/bigdata/images/image14.png?raw=true "restart hive services")
178+
![hive-config](https://github.com/pgsty/minio/blob/master/docs/bigdata/images/image14.png?raw=true "restart hive services")
179179

180180
## **4. Run Sample Applications**
181181

docs/bucket/lifecycle/DESIGN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ILM Tiering Design [![slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/)
22

3-
Lifecycle transition functionality provided in [bucket lifecycle guide](https://github.com/minio/minio/master/docs/bucket/lifecycle/README.md) allows tiering of content from MinIO object store to public clouds or other MinIO clusters.
3+
Lifecycle transition functionality provided in [bucket lifecycle guide](https://github.com/pgsty/minio/blob/master/docs/bucket/lifecycle/README.md) allows tiering of content from MinIO object store to public clouds or other MinIO clusters.
44

55
Transition tiers can be added to MinIO using `mc admin tier add` command to associate a `gcs`, `s3` or `azure` bucket or prefix path on a bucket to the tier name.
66
Lifecycle transition rules can be applied to buckets (both versioned and un-versioned) by specifying the tier name defined above as the transition storage class for the lifecycle rule.

docs/bucket/quota/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bucket Quota Configuration Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/)
22

3-
![quota](https://raw.githubusercontent.com/minio/minio/master/docs/bucket/quota/bucketquota.png)
3+
![quota](https://raw.githubusercontent.com/pgsty/minio/master/docs/bucket/quota/bucketquota.png)
44

55
Buckets can be configured to have `Hard` quota - it disallows writes to the bucket after configured quota limit is reached.
66

docs/bucket/replication/DESIGN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bucket Replication Design [![slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/)
22

3-
This document explains the design approach of server side bucket replication. If you're looking to get started with replication, we suggest you go through the [Bucket replication guide](https://github.com/minio/minio/blob/master/docs/bucket/replication/README.md) first.
3+
This document explains the design approach of server side bucket replication. If you're looking to get started with replication, we suggest you go through the [Bucket replication guide](https://github.com/pgsty/minio/blob/master/docs/bucket/replication/README.md) first.
44

55
## Overview
66

@@ -59,7 +59,7 @@ If 3 or more targets are participating in active-active replication, the replica
5959

6060
### Internal metadata for replication
6161

62-
`xl.meta` that is in use for [versioning](https://github.com/minio/minio/blob/master/docs/bucket/versioning/DESIGN.md) has additional metadata for replication of objects,delete markers and versioned deletes.
62+
`xl.meta` that is in use for [versioning](https://github.com/pgsty/minio/blob/master/docs/bucket/versioning/DESIGN.md) has additional metadata for replication of objects,delete markers and versioned deletes.
6363

6464
### Metadata for object replication - on source
6565

docs/bucket/replication/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The access key provided for the replication *target* cluster should have these m
9494
}
9595
```
9696

97-
Please note that the permissions required by the admin user on the target cluster can be more fine grained to exclude permissions like "s3:ReplicateDelete", "s3:GetBucketObjectLockConfiguration" etc depending on whether delete replication rules are set up or if object locking is disabled on `destbucket`. The above policies assume that replication of objects, tags and delete marker replication are all enabled on object lock enabled buckets. A sample script to setup replication is provided [here](https://github.com/minio/minio/blob/master/docs/bucket/replication/setup_replication.sh)
97+
Please note that the permissions required by the admin user on the target cluster can be more fine grained to exclude permissions like "s3:ReplicateDelete", "s3:GetBucketObjectLockConfiguration" etc depending on whether delete replication rules are set up or if object locking is disabled on `destbucket`. The above policies assume that replication of objects, tags and delete marker replication are all enabled on object lock enabled buckets. A sample script to setup replication is provided [here](https://github.com/pgsty/minio/blob/master/docs/bucket/replication/setup_replication.sh)
9898

9999
To set up replication from a source bucket `srcbucket` on myminio cluster to a bucket `destbucket` on the target minio cluster with endpoint https://replica-endpoint:9000, use:
100100
```
@@ -161,9 +161,9 @@ Replication status can be seen in the metadata on the source and destination obj
161161

162162
To perform bi-directional replication, repeat the above process on the target site - this time setting the source bucket as the replication target. It is recommended that replication be run in a system with at least two CPU's available to the process, so that replication can run in its own thread.
163163

164-
![put](https://raw.githubusercontent.com/minio/minio/master/docs/bucket/replication/PUT_bucket_replication.png)
164+
![put](https://raw.githubusercontent.com/pgsty/minio/master/docs/bucket/replication/PUT_bucket_replication.png)
165165

166-
![head](https://raw.githubusercontent.com/minio/minio/master/docs/bucket/replication/HEAD_bucket_replication.png)
166+
![head](https://raw.githubusercontent.com/pgsty/minio/master/docs/bucket/replication/HEAD_bucket_replication.png)
167167

168168
## Replica Modification sync
169169

@@ -210,11 +210,11 @@ Also note that `mc` version `RELEASE.2021-09-02T09-21-27Z` or older supports onl
210210

211211
Status of delete marker replication can be viewed by doing a GET/HEAD on the object version - it will return a `X-Minio-Replication-DeleteMarker-Status` header and http response code of `405`. In the case of permanent deletes, if the delete replication is pending or failed to propagate to the target cluster, GET/HEAD will return additional `X-Minio-Replication-Delete-Status` header and a http response code of `405`.
212212

213-
![delete](https://raw.githubusercontent.com/minio/minio/master/docs/bucket/replication/DELETE_bucket_replication.png)
213+
![delete](https://raw.githubusercontent.com/pgsty/minio/master/docs/bucket/replication/DELETE_bucket_replication.png)
214214

215215
The status of replication can be monitored by configuring event notifications on the source and target buckets using `mc event add`.On the source side, the `s3:PutObject`, `s3:Replication:OperationCompletedReplication` and `s3:Replication:OperationFailedReplication` events show the status of replication in the `X-Amz-Replication-Status` metadata.
216216

217-
On the target bucket, `s3:PutObject` event shows `X-Amz-Replication-Status` status of `REPLICA` in the metadata. Additional metrics to monitor backlog state for the purpose of bandwidth management and resource allocation are exposed via Prometheus - see <https://github.com/minio/minio/blob/master/docs/metrics/prometheus/list.md> for more details.
217+
On the target bucket, `s3:PutObject` event shows `X-Amz-Replication-Status` status of `REPLICA` in the metadata. Additional metrics to monitor backlog state for the purpose of bandwidth management and resource allocation are exposed via Prometheus - see <https://github.com/pgsty/minio/blob/master/docs/metrics/prometheus/list.md> for more details.
218218

219219
### Sync/Async Replication
220220

@@ -276,6 +276,6 @@ MinIO does not support SSE-C encrypted objects on replicated buckets, any applic
276276

277277
## Explore Further
278278

279-
- [MinIO Bucket Replication Design](https://github.com/minio/minio/blob/master/docs/bucket/replication/DESIGN.md)
279+
- [MinIO Bucket Replication Design](https://github.com/pgsty/minio/blob/master/docs/bucket/replication/DESIGN.md)
280280
- [MinIO Bucket Versioning Implementation](https://docs.min.io/community/minio-object-store/administration/object-management/object-retention.html)
281281
- [MinIO Client Quickstart Guide](https://docs.min.io/community/minio-object-store/reference/minio-mc.html#quickstart)

0 commit comments

Comments
 (0)