greenbone /
python-gvm
| @@ 61-153 (lines=93) @@ | ||
| 58 | # Is authenticated on gvmd |
|
| 59 | self._authenticated = False |
|
| 60 | ||
| 61 | def modify_user( |
|
| 62 | self, |
|
| 63 | user_id: str = None, |
|
| 64 | *, |
|
| 65 | name: Optional[str] = None, |
|
| 66 | comment: Optional[str] = None, |
|
| 67 | password: Optional[str] = None, |
|
| 68 | auth_source: Optional[UserAuthType] = None, |
|
| 69 | role_ids: Optional[List[str]] = None, |
|
| 70 | hosts: Optional[List[str]] = None, |
|
| 71 | hosts_allow: Optional[bool] = False, |
|
| 72 | ifaces: Optional[List[str]] = None, |
|
| 73 | ifaces_allow: Optional[bool] = False, |
|
| 74 | group_ids: Optional[List[str]] = None, |
|
| 75 | ) -> Any: |
|
| 76 | ||
| 77 | """Modifies an existing user. Most of the fields need to be supplied |
|
| 78 | for changing a single field even if no change is wanted for those. |
|
| 79 | Else empty values are inserted for the missing fields instead. |
|
| 80 | ||
| 81 | Arguments: |
|
| 82 | user_id: UUID of the user to be modified. |
|
| 83 | name: The new name for the user. |
|
| 84 | comment: Comment on the user. |
|
| 85 | password: The password for the user. |
|
| 86 | auth_source: Source allowed for authentication for this user. |
|
| 87 | roles_id: List of roles UUIDs for the user. |
|
| 88 | hosts: User access rules: List of hosts. |
|
| 89 | hosts_allow: Defines how the hosts list is to be interpreted. |
|
| 90 | If False (default) the list is treated as a deny list. |
|
| 91 | All hosts are allowed by default except those provided by |
|
| 92 | the hosts parameter. If True the list is treated as a |
|
| 93 | allow list. All hosts are denied by default except those |
|
| 94 | provided by the hosts parameter. |
|
| 95 | ifaces: User access rules: List of ifaces. |
|
| 96 | ifaces_allow: Defines how the ifaces list is to be interpreted. |
|
| 97 | If False (default) the list is treated as a deny list. |
|
| 98 | All ifaces are allowed by default except those provided by |
|
| 99 | the ifaces parameter. If True the list is treated as a |
|
| 100 | allow list. All ifaces are denied by default except those |
|
| 101 | provided by the ifaces parameter. |
|
| 102 | group_ids: List of group UUIDs for the user. |
|
| 103 | ||
| 104 | Returns: |
|
| 105 | The response. See :py:meth:`send_command` for details. |
|
| 106 | """ |
|
| 107 | if not user_id: |
|
| 108 | raise RequiredArgument( |
|
| 109 | function=self.modify_user.__name__, argument='user_id' |
|
| 110 | ) |
|
| 111 | ||
| 112 | cmd = XmlCommand("modify_user") |
|
| 113 | ||
| 114 | if user_id: |
|
| 115 | cmd.set_attribute("user_id", user_id) |
|
| 116 | ||
| 117 | if name: |
|
| 118 | cmd.add_element("new_name", name) |
|
| 119 | ||
| 120 | if role_ids: |
|
| 121 | for role in role_ids: |
|
| 122 | cmd.add_element("role", attrs={"id": role}) |
|
| 123 | ||
| 124 | if hosts: |
|
| 125 | cmd.add_element( |
|
| 126 | "hosts", |
|
| 127 | to_comma_list(hosts), |
|
| 128 | attrs={"allow": to_bool(hosts_allow)}, |
|
| 129 | ) |
|
| 130 | ||
| 131 | if ifaces: |
|
| 132 | cmd.add_element( |
|
| 133 | "ifaces", |
|
| 134 | to_comma_list(ifaces), |
|
| 135 | attrs={"allow": to_bool(ifaces_allow)}, |
|
| 136 | ) |
|
| 137 | ||
| 138 | if comment: |
|
| 139 | cmd.add_element("comment", comment) |
|
| 140 | ||
| 141 | if password: |
|
| 142 | cmd.add_element("password", password) |
|
| 143 | ||
| 144 | if auth_source: |
|
| 145 | _xmlauthsrc = cmd.add_element("sources") |
|
| 146 | _xmlauthsrc.add_element("source", auth_source.value) |
|
| 147 | ||
| 148 | if group_ids: |
|
| 149 | _xmlgroups = cmd.add_element("groups") |
|
| 150 | for group_id in group_ids: |
|
| 151 | _xmlgroups.add_element("group", attrs={"id": group_id}) |
|
| 152 | ||
| 153 | return self._send_xml_command(cmd) |
|
| 154 | ||
| @@ 3179-3276 (lines=98) @@ | ||
| 3176 | ||
| 3177 | return self._send_xml_command(cmd) |
|
| 3178 | ||
| 3179 | def modify_user( |
|
| 3180 | self, |
|
| 3181 | user_id: str = None, |
|
| 3182 | name: str = None, |
|
| 3183 | *, |
|
| 3184 | new_name: Optional[str] = None, |
|
| 3185 | comment: Optional[str] = None, |
|
| 3186 | password: Optional[str] = None, |
|
| 3187 | auth_source: Optional[UserAuthType] = None, |
|
| 3188 | role_ids: Optional[List[str]] = None, |
|
| 3189 | hosts: Optional[List[str]] = None, |
|
| 3190 | hosts_allow: Optional[bool] = False, |
|
| 3191 | ifaces: Optional[List[str]] = None, |
|
| 3192 | ifaces_allow: Optional[bool] = False, |
|
| 3193 | group_ids: Optional[List[str]] = None, |
|
| 3194 | ) -> Any: |
|
| 3195 | """Modifies an existing user. Most of the fields need to be supplied |
|
| 3196 | for changing a single field even if no change is wanted for those. |
|
| 3197 | Else empty values are inserted for the missing fields instead. |
|
| 3198 | Arguments: |
|
| 3199 | user_id: UUID of the user to be modified. Overrides name element |
|
| 3200 | argument. |
|
| 3201 | name: The name of the user to be modified. Either user_id or name |
|
| 3202 | must be passed. |
|
| 3203 | new_name: The new name for the user. |
|
| 3204 | comment: Comment on the user. |
|
| 3205 | password: The password for the user. |
|
| 3206 | auth_source: Source allowed for authentication for this user. |
|
| 3207 | roles_id: List of roles UUIDs for the user. |
|
| 3208 | hosts: User access rules: List of hosts. |
|
| 3209 | hosts_allow: Defines how the hosts list is to be interpreted. |
|
| 3210 | If False (default) the list is treated as a deny list. |
|
| 3211 | All hosts are allowed by default except those provided by |
|
| 3212 | the hosts parameter. If True the list is treated as a |
|
| 3213 | allow list. All hosts are denied by default except those |
|
| 3214 | provided by the hosts parameter. |
|
| 3215 | ifaces: User access rules: List of ifaces. |
|
| 3216 | ifaces_allow: Defines how the ifaces list is to be interpreted. |
|
| 3217 | If False (default) the list is treated as a deny list. |
|
| 3218 | All ifaces are allowed by default except those provided by |
|
| 3219 | the ifaces parameter. If True the list is treated as a |
|
| 3220 | allow list. All ifaces are denied by default except those |
|
| 3221 | provided by the ifaces parameter. |
|
| 3222 | group_ids: List of group UUIDs for the user. |
|
| 3223 | ||
| 3224 | Returns: |
|
| 3225 | The response. See :py:meth:`send_command` for details. |
|
| 3226 | """ |
|
| 3227 | if not user_id and not name: |
|
| 3228 | raise RequiredArgument( |
|
| 3229 | function=self.modify_user.__name__, argument='user_id or name' |
|
| 3230 | ) |
|
| 3231 | ||
| 3232 | cmd = XmlCommand("modify_user") |
|
| 3233 | ||
| 3234 | if user_id: |
|
| 3235 | cmd.set_attribute("user_id", user_id) |
|
| 3236 | else: |
|
| 3237 | cmd.add_element("name", name) |
|
| 3238 | ||
| 3239 | if new_name: |
|
| 3240 | cmd.add_element("new_name", new_name) |
|
| 3241 | ||
| 3242 | if role_ids: |
|
| 3243 | for role in role_ids: |
|
| 3244 | cmd.add_element("role", attrs={"id": role}) |
|
| 3245 | ||
| 3246 | if hosts: |
|
| 3247 | cmd.add_element( |
|
| 3248 | "hosts", |
|
| 3249 | to_comma_list(hosts), |
|
| 3250 | attrs={"allow": to_bool(hosts_allow)}, |
|
| 3251 | ) |
|
| 3252 | ||
| 3253 | if ifaces: |
|
| 3254 | cmd.add_element( |
|
| 3255 | "ifaces", |
|
| 3256 | to_comma_list(ifaces), |
|
| 3257 | attrs={"allow": to_bool(ifaces_allow)}, |
|
| 3258 | ) |
|
| 3259 | ||
| 3260 | if comment: |
|
| 3261 | cmd.add_element("comment", comment) |
|
| 3262 | ||
| 3263 | if password: |
|
| 3264 | cmd.add_element("password", password) |
|
| 3265 | ||
| 3266 | if auth_source: |
|
| 3267 | _xmlauthsrc = cmd.add_element("sources") |
|
| 3268 | _xmlauthsrc.add_element("source", auth_source.value) |
|
| 3269 | ||
| 3270 | if group_ids: |
|
| 3271 | _xmlgroups = cmd.add_element("groups") |
|
| 3272 | for group_id in group_ids: |
|
| 3273 | _xmlgroups.add_element("group", attrs={"id": group_id}) |
|
| 3274 | ||
| 3275 | return self._send_xml_command(cmd) |
|
| 3276 | ||
| 3277 | def restore(self, entity_id: str) -> Any: |
|
| 3278 | """Restore an entity from the trashcan |
|
| 3279 | ||
