ScriptSvnAuthenticationRequest

class ScriptSvnAuthenticationRequest.AuthenticationRequest

Bases: object

Subversion authentication request. Actually, one of the sub interfaces is delivered.

Note

Only available if the CODESYS SVN Plugin is installed!

property handled

Gets or sets a value indicating whether this AuthenticationRequest is handled. If handled is still false when the handler from the script finishes, the request will be passed on to the next handler (e. G. the UI window.)

Return type:

bool

Returns:

True if handled; otherwise, False.

property cancel

Cancels the request.

Return type:

bool

Note

This implicitly sets handled to True.

property type

Gets the type of authentication request.

Return type:

SvnAuthenticationType

property realm

Gets the authentication realm. This is a text usually including the server URL and the realm name configured in the server configuration.

Return type:

str

property realm_url

Gets the realm URL parsed out of the realm.

Return type:

Uri

property may_save

Gets a value indicating whether the authentication info may be saved.

Return type:

bool

Returns:

True if the authentication info may be saved; otherwise, False.

Note

The Subversion documentation says: If may_save is FALSE, the auth system does not allow the credentials to be saved (to disk). A prompt function shall not ask the user if the credentials shall be saved if may_save is FALSE. For example, a GUI client with a remember password checkbox would grey out the checkbox if may_save is FALSE.

property save

Gets or sets a value indicating whether the authentication info is to be saved.

Return type:

bool

Returns:

True if the authentication info is to be saved; otherwise, False.

Note

This implicitly sets handled to True.

class ScriptSvnAuthenticationRequest.UsernamePasswordAuthenticationRequest

Bases: AuthenticationRequest

Request a username and a password for authentication. Currently comes with an AuthenticationRequest.type of SvnAuthenticationType.UsernamePassword to request a username and a password.

Note

Only available if the CODESYS SVN Plugin is installed!

property username

Gets or sets the username.

Return type:

str

Returns:

The username.

Note

This implicitly sets handled to True.

property password

Gets or sets the password.

Return type:

str

Returns:

The password.

Note

This implicitly sets handled to True.

property initialusername

Gets the initial name of the user. This is a suggestion by the subversion implementation, like the local login name provided by the OS.

Return type:

str

Returns:

The initial name of the user - may be None or the empty string if not defined.

Note

The subversion documentation explains this as follows: If username is non-NULL, then the user might be prompted only for a password, but credentials would still be filled with both username and password. For example, a typical usage would be to pass username on the first call, but then leave it NULL for subsequent calls, on the theory that if credentials failed, its as likely to be due to incorrect username as incorrect password.

class ScriptSvnAuthenticationRequest.UserNameAuthenticationRequest

Bases: AuthenticationRequest

Request a username for authentication. Comes with an AuthenticationRequest.type of SvnAuthenticationType.Username

Note

Only available if the CODESYS SVN Plugin is installed!

property username

Gets or sets the username.

Return type:

str

Returns:

The username.

Note

This implicitly sets handled to True.

class ScriptSvnAuthenticationRequest.PasswordAuthenticationRequest

Bases: AuthenticationRequest

Request a password for authentication. Currently comes with an AuthenticationRequest.type of SvnAuthenticationType.SslClientCertificatePassword to request the passphrase to unlock a client certificate.

Note

Only available if the CODESYS SVN Plugin is installed!

property password

Gets or sets the password.

Return type:

str

Returns:

The password.

Note

This implicitly sets handled to True.

class ScriptSvnAuthenticationRequest.ClientCertificateRequest

Bases: object

Request a client certificate for authentication. Currently comes with an AuthenticationRequest.type of SvnAuthenticationType.SslClientCertificate to request a certificate file name.

Note

Only available if the CODESYS SVN Plugin is installed!

property certificatefile

Gets or sets the certificate file name.

Return type:

str

Returns:

The certificatefile.

Note

This implicitly sets handled to True.

class ScriptSvnAuthenticationRequest.ServerTrustRequest

Bases: object

Request verification of trust for the server certificate. Currently comes with an AuthenticationRequest.type of SvnAuthenticationType.SslServerTrust to request trust for a server certificate.

Note

Only available if the CODESYS SVN Plugin is installed!

property certificate_value

Gets the certificate value.

Return type:

str

property issuer

Gets the issuer name.

Return type:

str

property valid_until

Gets the end date for certificate validity.

Return type:

str

property valid_from

Gets the start date for certificate validity.

Return type:

str

property fingerprint

Gets the fingerprint.

Return type:

str

property common_name

Gets the common name (usually the server name).

Return type:

str

property failures

Gets the failures which were detected for this certificate.

Return type:

SvnCertificateTrustFailures

property explanations

Gets human readable explanations for the failures. The Keys are the SvnCertificateTrustFailure flags, and the values are localized strings.

Return type:

Dictionary(object, object)

property accepted

Gets or sets a value indicating whether this ServerTrustRequest is accepted.

Return type:

bool

Returns:

True if accepted; otherwise, False.

Note

This implicitly sets handled to True.

class ScriptSvnAuthenticationRequest.SshTrustRequest

Bases: AuthenticationRequest

Gets the fingerprint.

Return type:

str

property fingerprint
property key_bits

Gets the key length in bits.

Return type:

int

Returns:

The key bits.

property server_key_type

Gets the type of the server key.

Return type:

SvnSshServerKeyType

Returns:

The type of the server key.

server_key_type_display_string(keyType)

Gets a key type string for display.

Parameters:

keyType (SvnSshServerKeyType) – Type of the key.

Return type:

str

Returns:

The display string for the Server Key type.

property failures

Gets the failures which were detected for this certificate.

Return type:

SvnSshTrustFailures

property explanations

Gets human readable explanations for the failures.

Return type:

Dictionary(object, object)

property accepted

Gets or sets a value indicating whether this SshTrustRequest is accepted.

Return type:

bool

Returns:

True if accepted; otherwise, False.

Note

This implicitly sets handled to True.