Skip to content

Commit 5edad71

Browse files
committed
Fix broken links after testing (neo4j#2333)
1 parent 17c0770 commit 5edad71

File tree

91 files changed

+433
-337
lines changed

Some content is hidden

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

91 files changed

+433
-337
lines changed

models/hospital/access-control-old.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[role=enterprise-edition]
22
[[auth-access-control]]
33
= Fine-grained access control
4-
:description: Describes an example that illustrates various aspects of security and fine-grained access control.
4+
:description: Describes an example that illustrates various aspects of security and fine-grained access control.
55

66
When creating a database, administrators may want to establish which users have the ability to access certain information.
77

8-
As described in xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
8+
As described in xref:authentication-authorization/built-in-roles.adoc[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
99
While these built-in roles cover many common daily scenarios, it is also possible to create custom roles for specific needs.
1010

1111
This page contains an example that illustrates various aspects of security and fine-grained access control.
@@ -35,7 +35,7 @@ They can be described using the properties:
3535
* `description`
3636

3737
`(:Disease)`::
38-
Known illnesses mapped in a catalog found in the database.
38+
Known illnesses mapped in a catalog found in the database.
3939
They can be described using the properties:
4040
+
4141
* `name`
@@ -85,7 +85,7 @@ This allows users to be created entirely within the database security model, a s
8585
For more information, see link:/docs/cypher-manual/{neo4j-version}/access-control/[Cypher Manual -> Access control].
8686

8787
The following examples show two different approaches to using Neo4j security features to support the _healthcare_ database application.
88-
The first approach uses xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
88+
The first approach uses xref:authentication-authorization/built-in-roles.adoc[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
8989

9090
In this example, consider five users of the _healthcare_ database:
9191

@@ -128,13 +128,13 @@ Neo4j comes with built-in roles that cover a number of common needs:
128128
* `architect` - Has all the capabilities of the publisher as well as the ability to manage indexes and constraints.
129129
* `admin` - Can perform architect actions as well as manage databases, users, roles, and privileges.
130130

131-
Consider Charlie from the example of users.
131+
Consider Charlie from the example of users.
132132
As a researcher, they do not need write access to the database, so they are assigned the `reader` role.
133133

134-
On the other hand, Alice (the doctor), Daniel (the nurse), and Bob (the receptionist) all need to update the database with new patient information, but do not need to expand the schema with new labels, relationship types, property names or indexes.
134+
On the other hand, Alice (the doctor), Daniel (the nurse), and Bob (the receptionist) all need to update the database with new patient information, but do not need to expand the schema with new labels, relationship types, property names or indexes.
135135
For this reason, they are all assigned the `editor` role.
136136

137-
Tina, the IT administrator who installs and manages the database, needs to be assigned the `admin` role.
137+
Tina, the IT administrator who installs and manages the database, needs to be assigned the `admin` role.
138138

139139
Here is how to grant roles to the users:
140140

@@ -183,11 +183,11 @@ Has the permission to save _diagnoses_ to the database, but not expand the schem
183183
Receptionist::
184184
Should be able to read and write all patient data, but not be able to see the symptoms, diseases, or diagnoses.
185185
Researcher::
186-
Should be able to perform statistical analysis of all data, except patients’ personal information, to which they should have restricted access.
186+
Should be able to perform statistical analysis of all data, except patients’ personal information, to which they should have restricted access.
187187
To illustrate two different ways of setting up the same effective privileges, two roles are created for comparison.
188188
Nurse::
189189
Should be able to perform all tasks that both the doctor and the receptionist can do.
190-
Granting both roles (doctor and receptionist) to the nurse does not work as expected.
190+
Granting both roles (doctor and receptionist) to the nurse does not work as expected.
191191
This is explained in the section dedicated to the creation of the `nurse` role.
192192
Junior nurse::
193193
While the senior nurse is able to save diagnoses just as a doctor can, some (junior) nurses might not be allowed to do that.
@@ -709,7 +709,7 @@ RETURN n.name, n.ssn, n.address, n.dateOfBirth;
709709
710710
[[detach-delete-restricted-user]]
711711
712-
With the `receptionist` role, Bob can delete any new patient nodes they have just created, but they are not able to delete patients that have already received diagnoses since those are connected to parts of the graph that Bob cannot see.
712+
With the `receptionist` role, Bob can delete any new patient nodes they have just created, but they are not able to delete patients that have already received diagnoses since those are connected to parts of the graph that Bob cannot see.
713713
Here is a demonstration of both scenarios:
714714
715715
[source, cypher]

modules/ROOT/pages/authentication-authorization/built-in-roles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ These include the rights to perform the following classes of tasks:
827827

828828
* Manage xref:authentication-authorization/database-administration.adoc[database privileges] to control the rights to perform actions on specific databases:
829829
** Manage access to a database and the right to start and stop a database.
830-
** Manage link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/indexes-for-search-performance/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/constraints/[constraints].
830+
** Manage link:{neo4j-docs-base-uri}/cypher-manual/5/indexes-for-search-performance/[indexes] and link:{neo4j-docs-base-uri}/cypher-manual/5/constraints/[constraints].
831831
** Allow the creation of labels, relationship types, or property names.
832832
** Manage transactions.
833833
* Manage xref:authentication-authorization/dbms-administration.adoc[DBMS privileges] to control the rights to perform actions on the entire system:

modules/ROOT/pages/authentication-authorization/dbms-administration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ CREATE ROLE deniedConfigurationViewer IF NOT EXISTS;
6565

6666
All DBMS privileges are relevant system-wide.
6767
Like user management, they do not belong to one specific database or graph.
68-
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
68+
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/5/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
6969

7070
image::privileges_grant_and_deny_syntax_dbms_privileges.svg[title="Syntax of GRANT and DENY DBMS Privileges"]
7171

@@ -2067,7 +2067,7 @@ In this case, `+*+` means 0 or more characters, and `?` matches exactly one char
20672067

20682068
[NOTE]
20692069
====
2070-
The name-globbing is subject to the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/syntax/naming/[Cypher Manual -> Naming rules and recommendations], with the exception that it may include dots, stars, and question marks without the need for escaping using backticks.
2070+
The name-globbing is subject to the link:{neo4j-docs-base-uri}/cypher-manual/5/syntax/naming/[Cypher Manual -> Naming rules and recommendations], with the exception that it may include dots, stars, and question marks without the need for escaping using backticks.
20712071
20722072
Each part of the name-globbing separated by dots may be individually quoted.
20732073
For example, `++mine.`procedureWith%`++` is allowed, but not `++mine.procedure`With%`++`.

modules/ROOT/pages/authentication-authorization/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For more information, see xref:authentication-authorization/password-and-user-re
2929
When triggered, Neo4j logs an error containing a timestamp and the message `failed to log in: too many failed attempts` in the _security.log_.
3030
====
3131
+
32-
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc#access-control-privileges-syntax[Manage privileges syntax].
32+
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc[Manage privileges syntax].
3333
Various scenarios that illustrate the use of the native auth provider are available in xref:tutorial/access-control.adoc[].
3434

3535
*User auth providers*::
@@ -48,7 +48,7 @@ The configuration steps are described in xref:authentication-authorization/sso-i
4848
*Custom-built plugin auth providers*::
4949
A plugin option for building custom integrations.
5050
It is recommended that this option is used as part of a custom delivery as negotiated with link:https://neo4j.com/professional-services/[Neo4j Professional Services].
51-
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins#extending-neo4j-security-plugins[Java Reference -> Authentication and authorization plugins].
51+
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins[Java Reference -> Authentication and authorization plugins].
5252

5353
*Kerberos authentication and single sign-on*::
5454
In addition to LDAP, native, and custom providers, Neo4j supports Kerberos for authentication and single sign-on.

modules/ROOT/pages/authentication-authorization/ldap-integration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ this LDAP group will fail authentication, even if their credentials are correct.
6565
|===
6666

6767
All settings are defined at server startup time in the default configuration file _xref:configuration/neo4j-conf.adoc[neo4j.conf]_ or can be modified at
68-
runtime using xref:procedures.adoc#procedure_dbms_setconfigvalue[`dbms.setConfigValue()`].
68+
runtime using xref:procedures.adoc#procedure_dbms_setConfigValue[`dbms.setConfigValue()`].
6969

7070

7171
[[auth-ldap-configure-provider]]
@@ -471,7 +471,7 @@ SET AUTH 'ldap' { SET ID 'cn=alice,ou=sales,dc=example,dc=com' }
471471
You can verify that your LDAP configuration is correct, and that the LDAP server responds, by using the LDAP command-line tool `ldapsearch`.
472472

473473
The `ldapsearch` command accepts the LDAP configuration setting values as input and verifies both the authentication (using the `simple` mechanism) and authorization of a user.
474-
See the https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation^] for more advanced usage and how to use SASL authentication mechanisms.
474+
See the link:https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation] for more advanced usage and how to use SASL authentication mechanisms.
475475

476476
. Verify the authentication and authorization of a user.
477477
For example, `john`.

modules/ROOT/pages/authentication-authorization/limitations.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ The known limitations and implications of Neo4j's role-based access control secu
1919
[[access-control-limitations-indexes]]
2020
== Security and indexes
2121

22-
As described in link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/indexes-for-search-performance/[Cypher Manual -> Indexes for search performance], Neo4j {neo4j-version} supports the creation and use of indexes to improve the performance of Cypher queries.
22+
As described in link:{neo4j-docs-base-uri}/cypher-manual/5/indexes-for-search-performance/[Cypher Manual -> Indexes for search performance], Neo4j {neo4j-version} supports the creation and use of indexes to improve the performance of Cypher queries.
2323

2424
Note that the Neo4j security model impacts the results of queries, regardless if the indexes are used or not.
2525
When using non full-text Neo4j indexes, a Cypher query will always return the same results it would have if no index existed.
2626
This means that, if the security model causes fewer results to be returned due to restricted read access in xref:authentication-authorization/manage-privileges.adoc[Graph and sub-graph access control],
2727
the index will also return the same fewer results.
2828

29-
However, this rule is not fully obeyed by link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/indexes-for-full-text-search[Cypher Manual -> Indexes for full-text search].
29+
However, this rule is not fully obeyed by link:{neo4j-docs-base-uri}/cypher-manual/5/indexes-for-full-text-search[Cypher Manual -> Indexes for full-text search].
3030
These specific indexes are backed by _Lucene_ internally.
3131
It is therefore not possible to know for certain whether a security violation has affected each specific entry returned from the index.
3232
In face of this, Neo4j will return zero results from full-text indexes in case it is determined that any result might be violating the security privileges active for that query.
@@ -51,7 +51,7 @@ CREATE FULLTEXT INDEX userNames FOR (n:User|Person) ON EACH [n.name, n.surname];
5151
[NOTE]
5252
====
5353
Full-text indexes support multiple labels.
54-
See link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/indexes-for-full-text-search/[Cypher Manual -> Indexes for full-text search] for more details on creating and using full-text indexes.
54+
See link:{neo4j-docs-base-uri}/cypher-manual/5/indexes-for-full-text-search/[Cypher Manual -> Indexes for full-text search] for more details on creating and using full-text indexes.
5555
====
5656

5757
After creating these indexes, it would appear that the latter two indexes accomplish the same thing.

modules/ROOT/pages/authentication-authorization/load-privileges.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ _This feature is available from Neo4j 5.13._
1616
This section explains how to use Cypher to manage load privileges.
1717
All load privileges apply to the whole system.
1818
Like DBMS privileges, they do not belong to one specific database or graph.
19-
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
19+
For more details on the differences between graphs, databases, and the DBMS, refer to link:{neo4j-docs-base-uri}/cypher-manual/5/introduction/cypher_neo4j/[Cypher Manual -> Cypher and Neo4j].
2020

2121
image::privileges_grant_and_deny_syntax_load_privileges.svg[width="800", title="Syntax of GRANT and DENY load Privileges"]
2222

2323
// TODO: add image later when there is more than one LOAD privilege
2424
//image::privileges_hierarchy_load.svg[title="Load privileges hierarchy"]
2525

26-
The load privileges apply to the Cypher link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/clauses/load-csv/[`LOAD CSV` clause], deciding whether or not the data can be loaded from the given source.
26+
The load privileges apply to the Cypher link:{neo4j-docs-base-uri}/cypher-manual/5/clauses/load-csv/[`LOAD CSV` clause], deciding whether or not the data can be loaded from the given source.
2727

2828
== Load privileges syntax
2929

modules/ROOT/pages/authentication-authorization/manage-execute-permissions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The elevated privileges only apply within the procedure or user-defined function
1515
--
1616
The steps below assume that the procedure or user-defined function is already developed and installed.
1717

18-
Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j#extending-neo4j[Java Reference -> Extending Neo4j] for a description of creating and using user-defined procedures and functions.
18+
Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/[Java Reference -> Extending Neo4j] for a description of creating and using user-defined procedures and functions.
1919
--
2020

2121

modules/ROOT/pages/authentication-authorization/manage-users.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ RETURN user AS adminUser
637637
[[access-control-list-user-auth-providers]]
638638
== Listing user auth providers
639639

640-
To inspect users' xref:authentication-authorization/auth-providers.adoc#access-control-list-user-auth-providers[auth providers], use `SHOW USERS WITH AUTH`.
640+
To inspect available user auth providers, use `SHOW USERS WITH AUTH`.
641641
The command produces a row per user per auth provider and yields the following two columns in addition to those output by `SHOW USERS`:
642642

643643
[options="header", width="100%", cols="1a,4,1m,^.^,^.^"]
@@ -746,6 +746,8 @@ WHERE provider = 'oidc1'
746746
747747
======
748748

749+
For more information about auth providers, see xref:authentication-authorization/auth-providers.adoc[User auth providers].
750+
749751
[[access-control-create-users]]
750752
== Creating users
751753

0 commit comments

Comments
 (0)