Skip to content

Commit d827e33

Browse files
authored
Add docs for Perforce IP enforcement (#691)
1 parent 830200f commit d827e33

File tree

1 file changed

+55
-13
lines changed

1 file changed

+55
-13
lines changed

docs/admin/repo/perforce.mdx

Lines changed: 55 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Sourcegraph will now talk to the Perforce host and sync the configured `depots`
6060

6161
It's worthwhile to note some limitations of this process:
6262

63-
- When syncing depots either [git p4](https://git-scm.com/docs/git-p4) or [p4-fusion](https://github.com/salesforce/p4-fusion) (recommended) are used to convert Perforce depots into git repositories so that Sourcegraph can index them.
63+
- When syncing depots [p4-fusion](https://github.com/salesforce/p4-fusion) is used to convert Perforce depots into git repositories so that Sourcegraph can index them.
6464
- Rename of a Perforce depot, including changing the depot on the Perforce server or the `repositoryPathPattern` config option, will cause a re-import of the depot.
6565
- Unless [permissions syncing](#repository-permissions) is enabled, Sourcegraph is not aware of the depot permissions, so it can't enforce access restrictions.
6666

@@ -126,11 +126,11 @@ If file-level permissions is not enabled, Sourcegraph provides limited support f
126126

127127
### File-level permissions
128128

129-
File-level permissions make the [syncing of subdirectories to match permission boundaries](#syncing-subdirectories-to-match-permission-boundaries) unnecessary.
129+
File-level permissions eliminate the need for [syncing subdirectories to match permission boundaries](#syncing-subdirectories-to-match-permission-boundaries).
130130

131131
To enable file-level permissions:
132132

133-
1. Enable [the feature in the site config](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@2a716bd/-/blob/schema/site.schema.json?L227-249):
133+
1. Add the following entry to your [site configuration file](https://sourcegraph.com/github.com/sourcegraph/sourcegraph@2a716bd/-/blob/schema/site.schema.json?L227-249):
134134

135135
```json
136136
{
@@ -150,27 +150,70 @@ To enable file-level permissions:
150150
}
151151
```
152152

153-
1. Save the configuration. Permissions will be synced in the background based on your [Perforce protects file](https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_protect.html).
153+
1. Save the configuration.
154154

155-
#### Handling Host rules in the protects file
155+
Permissions will be synced in the background based on your [Perforce protects file](https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_protect.html).
156156

157-
When file-level permissions are enabled, Sourcegraph will read the Perforce protects file to determine what users can access. Because Sourcegraph originates all depot access from one host, protects rules with a Host field cannot be followed exactly. By default, they are parsed as if they apply to all hosts, which can result in users losing access when they should have access. If you have protects rules with hosts that are causing lost access for users, you can set `ignoreRulesWithHost` to `true` in the code host configuration.
157+
#### Handling IP-based rules
158+
159+
Perforce's `protects` table allows administrators to define fine-grained access controls based on user identities and host IP addresses. By default, Sourcegraph applies all rules from the `protects` table without considering host-specific restrictions, effectively treating all host rules as the wildcard `*`. This behavior can lead to users having unintended access to repositories or files that should be restricted based on their IP addresses.
160+
161+
If your Perforce environment relies heavily on host-based permissions, it's crucial to configure Sourcegraph appropriately to respect these restrictions. This documentation provides detailed instructions on how to enforce or ignore host rules in Sourcegraph when integrating with Perforce.
162+
163+
##### Default Behavior
164+
165+
By default, Sourcegraph:
166+
167+
- **Applies all rules** in the Perforce `protects` table.
168+
- **Ignores host-specific restrictions**, treating all host fields as `*`.
169+
170+
**Implication**: Users may gain access to resources that should be restricted based on their IP addresses.
171+
172+
##### Configuration Options
173+
174+
To ensure Sourcegraph handles host rules according to your requirements, you have two additional options:
175+
176+
1. **Enforce Host Rules**: Configure Sourcegraph to respect and enforce IP-based restrictions defined in the `protects` table.
177+
2. **Ignore Host-Specific Rules**: Configure Sourcegraph to disregard any rules with a host value other than `*`.
178+
179+
##### Enforcing host rules
180+
181+
If you want Sourcegraph to enforce host-specific permissions, you need to enable IP restriction enforcement in your [site configuration](https://sourcegraph.com/docs/admin/config/site_config):
158182

159183
```json
160-
{
161-
"authorization": {
162-
"subRepoPermissions": true,
163-
"ignoreRulesWithHost": true
164-
}
184+
{
185+
"experimentalFeatures": {
186+
"subRepoPermissions": {
187+
"enabled": true,
188+
"enforceIPRestrictions": true
165189
}
190+
}
191+
}
166192
```
193+
<Callout type="warning">
194+
When `enforceIPRestrictions` is set to `true`, Sourcegraph will use the user's IP address to apply Perforce permissions at the user level. It uses the final `X-Forwarded-For` header in the request to identify the user's IP. Note that this header can be easily spoofed, so ensure your load balancer or proxy handles `X-Forwarded-For` headers securely.
195+
</Callout>
196+
197+
##### Ignore rules with host
198+
199+
To ignore rules that have a host value other than `*`, set `ignoreRulesWithHost` to `true` in your **code host configuration**:
200+
201+
```json
202+
{
203+
"authorization": {
204+
"subRepoPermissions": true,
205+
"ignoreRulesWithHost": true
206+
}
207+
}
208+
```
209+
210+
With this setting, Sourcegraph will ignore any rules with a host other than `*`, treating them as if they do not exist.
167211

168212
### Notes about permissions
169213

170214
- Sourcegraph users are mapped to Perforce users based on their verified email addresses.
171215
- As long as a user has been granted at least `Read` permissions in Perforce they will be able to view content in Sourcegraph.
172216
- As a special case, commits in which a user does not have permissions to read any files are hidden. If a user can read a subset of files in a commit, only those files are shown.
173-
- [The host field from protections are not supported](#known-issues-and-limitations).
174217
- [file-level permissions must be disabled for Batch Changes to work](#known-issues-and-limitations).
175218
- Setting `authz.enforceForSiteAdmins` to `true` in the site configuration will enforce permissions for admin users. They may not be able to see repositories and their contents if their Sourcegraph user account email does not match with their email on the Perforce server.
176219

@@ -228,7 +271,6 @@ When file-level permissions are enabled, Sourcegraph will read the Perforce prot
228271
We are actively working to significantly improve Sourcegraph's Perforce support. Please [file an issue](https://github.com/sourcegraph/sourcegraph/issues) to help us prioritize any specific improvements you'd like to see.
229272

230273
- Sourcegraph was initially built for Git repositories only, so it stores Perforce depots as Git repositories when syncing. Perforce concepts and languages are expressed in the UI, but under the hood, Git tools are used.
231-
- The [host field](https://www.perforce.com/manuals/cmdref/Content/CmdRef/p4_protect.html#Form_Fields_..361) in protections is not supported.
232274
- Batch Changes does not support [file-level permissions](#file-level-permissions) (also known as sub-repo permissions)
233275
- Batch Changes does not handle the shelved changelist other than to query the Perforce server for its status.
234276
- Permalinks with Changelist Id do not work yet

0 commit comments

Comments
 (0)