Skip to content

Commit

Permalink
Merge pull request #42 from ambitus/gh-pages-dev
Browse files Browse the repository at this point in the history
Release 1.0b2
  • Loading branch information
ElijahSwiftIBM authored Nov 16, 2023
2 parents e4f332a + bb6ba9b commit 89f67bf
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 19 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ _site
.jekyll-cache
.jekyll-metadata
vendor
poetry.lock

.vscode
Gemfile.lock
Expand Down
11 changes: 11 additions & 0 deletions resource/base/segments_traits_operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,30 @@ Traits use the following syntax: `<segment>:<trait>`
| `cdtinfo:case_allowed` | Set the **Case Allowed** for the names of profiles in this resource class. | `str`, `False` |
| `cdtinfo:default_racroute_return_code` | Set the **Default Return Code** for requests to access profiles in this resource class. | `int`, `False` |
| `cdtinfo:valid_first_characters` | Set the **Valid Character Types** for the first characters in names of profiles in this resource class. | `str`, `False` |
| `cdtinfo:generic_profile_checking` | Specifies whether the SETROPTS **GENERIC** and SETROPTS **GENCMD** options are allowed for this resource class. These allow generic profile checking and generic profile command processing for this resource class. | `str`, `False` |
| `cdtinfo:generic_profile_sharing` | Specifies whether the SETROPTS **GENLIST** option is allowed for this resource class. This allows generic profiles that are successfully accessed to be stored in common storage and shared. | `str`, `False` |
| `cdtinfo:grouping_class_name` | Set the **Grouping Class** name associated with this resource class. | `str`, `False` |
| `cdtinfo:key_qualifiers` | Set the number of **Qualifiers** used to determine a match for profiles in this resource class | `int` |
| `cdtinfo:manditory_access_control_processing` | Specifies which type of **Mandatory Access Control** processing is required for this resource class. | `str`, `False` |
| `cdtinfo:max_length` | Set the **Maximum Length** for the names of profiles within this resource class. | `str`, `False` |
| `cdtinfo:max_length_entityx` | Set the **Maximum Length** for the names of profiles when a RACROUTE macro is invoked with the ENTITYX keyword within this resource class. | `str`, `False` |
| `cdtinfo:member_class_name` | Set the **Member Class** name associated with this resource class. | `str`, `False` |
| `cdtinfo:operations` | Specifies if RACF should consider the **Operations** attribute when it performs authorization checking. | `str`, `False` |
| `cdtinfo:valid_other_characters` | Set the **Valid Character Types** for the other characters in names of profiles in this resource class. | `str`, `False` |
| `cdtinfo:posit_number` | Set the **Posit Number** for this resource class. This controls flags that control many RACF processing options. | `int`, `False` |
| `cdtinfo:profiles_allowed` | Specifies whether or not **Profiles are Allowed** for this resource class. | `bool` |
| `cdtinfo:raclist_allowed` | Specifies whether or not this class is **Allowed to be Raclisted**. | `bool` |
| `cdtinfo:send_enf_signal_on_profile_creation` | Specify whether or not **ENF Signals** should be sent to listeners for raclisted profiles in this resource class when they are created, updated, or deleted. | `str`, `False` |
| `cdtinfo:security_label_required` | Specify whether or not **Security Labels** are required for the profiles in this resource class. | `str`, `False` |
| `cdtinfo:default_universal_access` | Set the **Default Universal Access Value** for profiles in this resource class. | `str`, `False` |
| `cfdef:help_text` | Set the **Help Text** for this custom field. | `str` |
| `cfdef:valid_first_characters` | Set the **Valid Character Types** for the first characters in values for this custom field. | `str` |
| `cfdef:valid_other_characters` | Set the **Valid Character Types** for the other characters in values for this custom field. | `str` |
| `kerb:key_encryption_type` | Set the **Encryption Algorithms** for this kerberos realm. | `str`, `False` |
| `session:security_checking_level` | Specifies the **Level(s) of Security Checking** performed when conversations are established with the LU protected by this profile. | `str`, `False` |
| `session:session_key_interval` | The **Maximum Number of Days** that the session key is valid. | `int`, `False` |
| `session:locked` | Specify whether or not this profile is **Locked**. | `bool` |
| `session:session_key` | Set the **Session Key** for this profile to be used in the specified connection. | `int`, `str`, `False` |
| `sigver:log_signature_verification_events` | Specifies whether to **Audit Signature Verification Events** for this signed program. | `str`, `False` |
| `stdata:group` | Set the **Group** to associate with this started task. | `str`, `False` |
| `stdata:privileged` | Specify whether or not this started task runs with the **RACF Privileged** attribute. | `bool` |
Expand Down
27 changes: 20 additions & 7 deletions resource/subfunctions/appc_session.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,6 @@ def extract_appc_session(

#### 📄 Description

&nbsp;

{: .experimental }
> _So far, no tested **Segments** and **Traits** are considered **Stable** when extracting the `session` segment. This is how the function will work when **Traits** for the `session` segment are made **Stable**._
&nbsp;

Extract an existing **APPC Session** profile in the **APPCLU** class.

#### 📥 Parameters
Expand All @@ -218,6 +211,26 @@ Extract an existing **APPC Session** profile in the **APPCLU** class.
* `SecurityRequestError`<br>
Raises `SecurityRequestError` when the **Return Code** of a **Security Result** returned by IRRSMO00 is **NOT** equal to `0`.

#### 💻 Example

###### Python REPL
```python
from pyracf import ResourceAdmin
resource_admin = ResourceAdmin()
resource_admin.extract_appc_session("TSTNET", "TSTLOCLU", "TSTPRTLU")
{"sessionKeyInterval": 5, "locked": True, "sessionKey": "e3c5e2e3d2c5e800", "securityCheckingLevel": "conv"}
```

###### Security Result Dictionary as JSON
```json
{
"sessionKeyInterval": 5,
"locked": true,
"sessionKey": "e3c5e2e3d2c5e800",
"securityCheckingLevel": "conv",
}
```

## `ResourceAdmin.delete_appc_session()`

```python
Expand Down
6 changes: 3 additions & 3 deletions resource/subfunctions/kerberos_realm.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,14 @@ Extract an existing **Kerberos Realm** profile in the **REALM** class.
from pyracf import ResourceAdmin
resource_admin = ResourceAdmin()
resource_admin.extract_kerberos_realm("TSTTSKEL")
{'user': '', 'group': '', 'trusted': 'yes', 'privileged': None, 'trace': None}
{'user': None, 'group': None, 'trusted': 'yes', 'privileged': None, 'trace': None}
```

###### Trait Dictionary as JSON
```json
{
"user": "",
"group": "",
"user": null,
"group": null,
"trusted": "yes",
"privileged": null,
"trace": null
Expand Down
6 changes: 3 additions & 3 deletions resource/subfunctions/resource_class.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Extract an existing **Resource Class** profile in the **CDT** class.
from pyracf import ResourceAdmin
resource_admin = ResourceAdmin()
resource_admin.extract_resource_class("SHELCITY")
{'case': 'upper', 'defaultrc': 8, 'defaultuacc': None, 'first': 'alpha', 'genlist': 'disallowed', 'generic': 'allowed', 'group': '', 'keyqualifiers': 0, 'macprocessing': 'normal', 'maxlength': 246, 'maxlenx': 246, 'member': '', 'operations': None, 'other': ['alpha', 'numeric'], 'posit': 200, 'profilesallowed': 'yes', 'raclist': 'allowed', 'seclabelsrequired': None, 'signal': None}
{'case': 'upper', 'defaultrc': 8, 'defaultuacc': None, 'first': 'alpha', 'genlist': 'disallowed', 'generic': 'allowed', 'group': None, 'keyqualifiers': 0, 'macprocessing': 'normal', 'maxlength': 246, 'maxlenx': 246, 'member': None, 'operations': None, 'other': ['alpha', 'numeric'], 'posit': 200, 'profilesallowed': 'yes', 'raclist': 'allowed', 'seclabelsrequired': None, 'signal': None}
```

###### Trait Dictionary as JSON
Expand All @@ -244,12 +244,12 @@ resource_admin.extract_resource_class("SHELCITY")
"first": "alpha",
"genlist": "disallowed",
"generic": "allowed",
"group": "",
"group": null,
"keyqualifiers": 0,
"macprocessing": "normal",
"maxlength": 246,
"maxlenx": 246,
"member": "",
"member": null,
"operations": null,
"other": [
"alpha",
Expand Down
6 changes: 3 additions & 3 deletions resource/subfunctions/started_task.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,14 +202,14 @@ Extract an existing **Started Task** profile in the **STARTED** class.
from pyracf import ResourceAdmin
resource_admin = ResourceAdmin()
resource_admin.extract_started_task("TSTTSKEL")
{'user': '', 'group': '', 'trusted': 'yes', 'privileged': None, 'trace': None}
{'user': None, 'group': None, 'trusted': 'yes', 'privileged': None, 'trace': None}
```

###### Trait Dictionary as JSON
```json
{
"user": "",
"group": "",
"user": null,
"group": null,
"trusted": "yes",
"privileged": null,
"trace": null
Expand Down
Loading

0 comments on commit 89f67bf

Please sign in to comment.