Migrate management framework plugins to use Principal parameter

All plugins will now use this parameter and common code for all operations on
Kerberos principals.  Additional semantic validators and normalizers were
added to determine or append a correct realm so that the previous behavior is
kept intact.

https://fedorahosted.org/freeipa/ticket/3864

Reviewed-By: David Kupka <dkupka@redhat.com>
Reviewed-By: Jan Cholasta <jcholast@redhat.com>

1 files changed, 38 insertions, 38 deletions

diff --git a/API.txt b/API.txt
index c01692e17..704dcde3c 100644
--- a/API.txt
+++ b/API.txt
@@ -738,14 +738,14 @@ option: Int('max_serial_number?', autofill=False)
 option: Int('min_serial_number?', autofill=False)
 option: Str('no_host*', cli_name='no_hosts')
 option: Flag('no_members', autofill=True, default=True)
-option: Str('no_service*', cli_name='no_services')
+option: Principal('no_service*', cli_name='no_services')
 option: Str('no_user*', cli_name='no_users')
 option: Flag('pkey_only?', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
 option: Int('revocation_reason?', autofill=False)
 option: DateTime('revokedon_from?', autofill=False)
 option: DateTime('revokedon_to?', autofill=False)
-option: Str('service*', cli_name='services')
+option: Principal('service*', cli_name='services')
 option: Int('sizelimit?')
 option: Str('subject?', autofill=False)
 option: Int('timelimit?')
@@ -771,7 +771,7 @@ arg: Str('csr', cli_name='csr_file')
 option: Flag('add', autofill=True, default=False)
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('cacn?', autofill=True, cli_name='ca', default=u'ipa')
-option: Str('principal')
+option: Principal('principal')
 option: Str('profile_id?')
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
 option: Str('request_type', autofill=True, default=u'pkcs10')
@@ -2436,7 +2436,7 @@ option: Bool('ipakrbokasdelegate?', autofill=False, cli_name='ok_as_delegate')
 option: Bool('ipakrbrequirespreauth?', autofill=False, cli_name='requires_pre_auth')
 option: Str('ipasshpubkey*', autofill=False, cli_name='sshpubkey')
 option: Str('krbprincipalauthind*', autofill=False, cli_name='auth_ind')
-option: Str('krbprincipalname?', cli_name='principalname')
+option: Principal('krbprincipalname?', cli_name='principalname')
 option: Str('l?', autofill=False, cli_name='locality')
 option: Str('macaddress*', autofill=False)
 option: Flag('no_members', autofill=True, default=False)
@@ -3401,7 +3401,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: passwd/1
 args: 3,2,3
-arg: Str('principal', autofill=True, cli_name='user')
+arg: Principal('principal', autofill=True, cli_name='user')
 arg: Password('password')
 arg: Password('current_password', autofill=True, confirm=False)
 option: Password('otp?', confirm=False)
@@ -4271,7 +4271,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_add/1
 args: 1,12,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Str('addattr*', cli_name='addattr')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('force', autofill=True, default=False)
@@ -4289,7 +4289,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_add_cert/1
 args: 1,5,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
@@ -4300,7 +4300,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_add_host/1
 args: 1,5,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('host*', alwaysask=True, cli_name='hosts')
 option: Flag('no_members', autofill=True, default=False)
@@ -4311,7 +4311,7 @@ output: Output('failed', type=[<type 'dict'>])
 output: Entry('result')
 command: service_allow_create_keytab/1
 args: 1,8,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Str('host*', alwaysask=True, cli_name='hosts')
@@ -4325,7 +4325,7 @@ output: Output('failed', type=[<type 'dict'>])
 output: Entry('result')
 command: service_allow_retrieve_keytab/1
 args: 1,8,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Str('host*', alwaysask=True, cli_name='hosts')
@@ -4339,7 +4339,7 @@ output: Output('failed', type=[<type 'dict'>])
 output: Entry('result')
 command: service_del/1
 args: 1,2,3
-arg: Str('krbprincipalname+', cli_name='principal')
+arg: Principal('krbprincipalname+', cli_name='principal')
 option: Flag('continue', autofill=True, cli_name='continue', default=False)
 option: Str('version?')
 output: Output('result', type=[<type 'dict'>])
@@ -4347,14 +4347,14 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: ListOfPrimaryKeys('value')
 command: service_disable/1
 args: 1,1,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Str('version?')
 output: Output('result', type=[<type 'bool'>])
 output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_disallow_create_keytab/1
 args: 1,8,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Str('host*', alwaysask=True, cli_name='hosts')
@@ -4368,7 +4368,7 @@ output: Output('failed', type=[<type 'dict'>])
 output: Entry('result')
 command: service_disallow_retrieve_keytab/1
 args: 1,8,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Str('host*', alwaysask=True, cli_name='hosts')
@@ -4386,7 +4386,7 @@ arg: Str('criteria?')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: StrEnum('ipakrbauthzdata*', autofill=False, cli_name='pac_type', values=[u'MS-PAC', u'PAD', u'NONE'])
 option: Str('krbprincipalauthind*', autofill=False, cli_name='auth_ind')
-option: Str('krbprincipalname?', autofill=False, cli_name='principal')
+option: Principal('krbprincipalname?', autofill=False, cli_name='principal')
 option: Str('man_by_host*', cli_name='man_by_hosts')
 option: Flag('no_members', autofill=True, default=True)
 option: Str('not_man_by_host*', cli_name='not_man_by_hosts')
@@ -4401,7 +4401,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: Output('truncated', type=[<type 'bool'>])
 command: service_mod/1
 args: 1,13,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Str('addattr*', cli_name='addattr')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('delattr*', cli_name='delattr')
@@ -4420,7 +4420,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_remove_cert/1
 args: 1,5,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
@@ -4431,7 +4431,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
 output: PrimaryKey('value')
 command: service_remove_host/1
 args: 1,5,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('host*', alwaysask=True, cli_name='hosts')
 option: Flag('no_members', autofill=True, default=False)
@@ -4442,7 +4442,7 @@ output: Output('failed', type=[<type 'dict'>])
 output: Entry('result')
 command: service_show/1
 args: 1,6,3
-arg: Str('krbprincipalname', cli_name='principal')
+arg: Principal('krbprincipalname', cli_name='principal')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('no_members', autofill=True, default=False)
 option: Str('out?')
@@ -4646,7 +4646,7 @@ option: Str('ipatokenradiusconfiglink?', cli_name='radius')
 option: Str('ipatokenradiususername?', cli_name='radius_username')
 option: StrEnum('ipauserauthtype*', cli_name='user_auth_type', values=[u'password', u'radius', u'otp'])
 option: DateTime('krbprincipalexpiration?', cli_name='principal_expiration')
-option: Str('krbprincipalname?', autofill=True, cli_name='principal')
+option: Principal('krbprincipalname?', autofill=True, cli_name='principal')
 option: Str('l?', cli_name='city')
 option: Str('loginshell?', cli_name='shell')
 option: Str('mail*', cli_name='email')
@@ -4717,7 +4717,7 @@ option: Str('ipatokenradiusconfiglink?', autofill=False, cli_name='radius')
 option: Str('ipatokenradiususername?', autofill=False, cli_name='radius_username')
 option: StrEnum('ipauserauthtype*', autofill=False, cli_name='user_auth_type', values=[u'password', u'radius', u'otp'])
 option: DateTime('krbprincipalexpiration?', autofill=False, cli_name='principal_expiration')
-option: Str('krbprincipalname?', autofill=False, cli_name='principal')
+option: Principal('krbprincipalname?', autofill=False, cli_name='principal')
 option: Str('l?', autofill=False, cli_name='city')
 option: Str('loginshell?', autofill=False, cli_name='shell')
 option: Str('mail*', autofill=False, cli_name='email')
@@ -5633,7 +5633,7 @@ option: Str('ipatokenradiusconfiglink?', cli_name='radius')
 option: Str('ipatokenradiususername?', cli_name='radius_username')
 option: StrEnum('ipauserauthtype*', cli_name='user_auth_type', values=[u'password', u'radius', u'otp'])
 option: DateTime('krbprincipalexpiration?', cli_name='principal_expiration')
-option: Str('krbprincipalname?', autofill=True, cli_name='principal')
+option: Principal('krbprincipalname?', autofill=True, cli_name='principal')
 option: Str('l?', cli_name='city')
 option: Str('loginshell?', cli_name='shell')
 option: Str('mail*', cli_name='email')
@@ -5732,7 +5732,7 @@ option: Str('ipatokenradiusconfiglink?', autofill=False, cli_name='radius')
 option: Str('ipatokenradiususername?', autofill=False, cli_name='radius_username')
 option: StrEnum('ipauserauthtype*', autofill=False, cli_name='user_auth_type', values=[u'password', u'radius', u'otp'])
 option: DateTime('krbprincipalexpiration?', autofill=False, cli_name='principal_expiration')
-option: Str('krbprincipalname?', autofill=False, cli_name='principal')
+option: Principal('krbprincipalname?', autofill=False, cli_name='principal')
 option: Str('l?', autofill=False, cli_name='city')
 option: Str('loginshell?', autofill=False, cli_name='shell')
 option: Str('mail*', autofill=False, cli_name='email')
@@ -5899,7 +5899,7 @@ option: Bytes('ipavaultsalt?', cli_name='salt')
 option: StrEnum('ipavaulttype?', autofill=True, cli_name='type', default=u'symmetric', values=[u'standard', u'symmetric', u'asymmetric'])
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('setattr*', cli_name='setattr')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
@@ -5914,7 +5914,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -5930,7 +5930,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -5945,7 +5945,7 @@ arg: Str('cn', cli_name='name')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Bytes('nonce')
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Bytes('session_key')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
@@ -5958,7 +5958,7 @@ command: vault_del/1
 args: 1,5,3
 arg: Str('cn+', cli_name='name')
 option: Flag('continue', autofill=True, cli_name='continue', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
 option: Str('version?')
@@ -5975,7 +5975,7 @@ option: StrEnum('ipavaulttype?', autofill=False, cli_name='type', default=u'symm
 option: Flag('no_members', autofill=True, default=True)
 option: Flag('pkey_only?', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Flag('services?', autofill=True, default=False)
 option: Flag('shared?', autofill=True, default=False)
 option: Int('sizelimit?', autofill=False)
@@ -6000,7 +6000,7 @@ option: StrEnum('ipavaulttype?', autofill=False, cli_name='type', default=u'symm
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
 option: Flag('rights', autofill=True, default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('setattr*', cli_name='setattr')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
@@ -6015,7 +6015,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -6031,7 +6031,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -6045,7 +6045,7 @@ args: 1,7,3
 arg: Str('cn', cli_name='name')
 option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Bytes('session_key')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
@@ -6060,7 +6060,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
 option: Flag('rights', autofill=True, default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
 option: Str('version?')
@@ -6082,7 +6082,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -6094,7 +6094,7 @@ output: Entry('result')
 command: vaultcontainer_del/1
 args: 0,5,3
 option: Flag('continue', autofill=True, cli_name='continue', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
 option: Str('version?')
@@ -6107,7 +6107,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Str('group*', alwaysask=True, cli_name='groups')
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Str('services*', alwaysask=True, cli_name='services')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('user*', alwaysask=True, cli_name='users')
@@ -6122,7 +6122,7 @@ option: Flag('all', autofill=True, cli_name='all', default=False)
 option: Flag('no_members', autofill=True, default=False)
 option: Flag('raw', autofill=True, cli_name='raw', default=False)
 option: Flag('rights', autofill=True, default=False)
-option: Str('service?')
+option: Principal('service?')
 option: Flag('shared?', autofill=True, default=False)
 option: Str('username?', cli_name='user')
 option: Str('version?')