Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

# Authors: 

#   Rob Crittenden <rcritten@redhat.com> 

#   Pavel Zuna <pzuna@redhat.com> 

# 

# Copyright (C) 2009  Red Hat 

# see file 'COPYING' for use and warranty information 

# 

# This program is free software; you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the GNU General Public License 

# along with this program.  If not, see <http://www.gnu.org/licenses/>. 

""" 

Directory Server Access Control Instructions (ACIs) 

 

ACIs are used to allow or deny access to information. This module is 

currently designed to allow, not deny, access. 

 

The aci commands are designed to grant permissions that allow updating 

existing entries or adding or deleting new ones. The goal of the ACIs 

that ship with IPA is to provide a set of low-level permissions that 

grant access to special groups called taskgroups. These low-level 

permissions can be combined into roles that grant broader access. These 

roles are another type of group, roles. 

 

For example, if you have taskgroups that allow adding and modifying users you 

could create a role, useradmin. You would assign users to the useradmin 

role to allow them to do the operations defined by the taskgroups. 

 

You can create ACIs that delegate permission so users in group A can write 

attributes on group B. 

 

The type option is a map that applies to all entries in the users, groups or 

host location. It is primarily designed to be used when granting add 

permissions (to write new entries). 

 

An ACI consists of three parts: 

1. target 

2. permissions 

3. bind rules 

 

The target is a set of rules that define which LDAP objects are being 

targeted. This can include a list of attributes, an area of that LDAP 

tree or an LDAP filter. 

 

The targets include: 

- attrs: list of attributes affected 

- type: an object type (user, group, host, service, etc) 

- memberof: members of a group 

- targetgroup: grant access to modify a specific group. This is primarily 

  designed to enable users to add or remove members of a specific group. 

- filter: A legal LDAP filter used to narrow the scope of the target. 

- subtree: Used to apply a rule across an entire set of objects. For example, 

  to allow adding users you need to grant "add" permission to the subtree 

  ldap://uid=*,cn=users,cn=accounts,dc=example,dc=com. The subtree option 

  is a fail-safe for objects that may not be covered by the type option. 

 

The permissions define what the ACI is allowed to do, and are one or 

more of: 

1. write - write one or more attributes 

2. read - read one or more attributes 

3. add - add a new entry to the tree 

4. delete - delete an existing entry 

5. all - all permissions are granted 

 

Note the distinction between attributes and entries. The permissions are 

independent, so being able to add a user does not mean that the user will 

be editable. 

 

The bind rule defines who this ACI grants permissions to. The LDAP server 

allows this to be any valid LDAP entry but we encourage the use of 

taskgroups so that the rights can be easily shared through roles. 

 

For a more thorough description of access controls see 

http://www.redhat.com/docs/manuals/dir-server/ag/8.0/Managing_Access_Control.html 

 

EXAMPLES: 

 

NOTE: ACIs are now added via the permission plugin. These examples are to 

demonstrate how the various options work but this is done via the permission 

command-line now (see last example). 

 

Add an ACI so that the group "secretaries" can update the address on any user: 

   ipa group-add --desc="Office secretaries" secretaries 

   ipa aci-add --attrs=streetAddress --memberof=ipausers --group=secretaries --permissions=write --prefix=none "Secretaries write addresses" 

 

Show the new ACI: 

   ipa aci-show --prefix=none "Secretaries write addresses" 

 

Add an ACI that allows members of the "addusers" permission to add new users: 

   ipa aci-add --type=user --permission=addusers --permissions=add --prefix=none "Add new users" 

 

Add an ACI that allows members of the editors manage members of the admins group: 

   ipa aci-add --permissions=write --attrs=member --targetgroup=admins --group=editors --prefix=none "Editors manage admins" 

 

Add an ACI that allows members of the admins group to manage the street and zip code of those in the editors group: 

   ipa aci-add --permissions=write --memberof=editors --group=admins --attrs=street,postalcode --prefix=none "admins edit the address of editors" 

 

Add an ACI that allows the admins group manage the street and zipcode of those who work for the boss: 

   ipa aci-add --permissions=write --group=admins --attrs=street,postalcode --filter="(manager=uid=boss,cn=users,cn=accounts,dc=example,dc=com)" --prefix=none "Edit the address of those who work for the boss" 

 

Add an entirely new kind of record to IPA that isn't covered by any of the --type options, creating a permission: 

   ipa permission-add  --permissions=add --subtree="cn=*,cn=orange,cn=accounts,dc=example,dc=com" --desc="Add Orange Entries" add_orange 

 

 

The show command shows the raw 389-ds ACI. 

 

IMPORTANT: When modifying the target attributes of an existing ACI you 

must include all existing attributes as well. When doing an aci-mod the 

targetattr REPLACES the current attributes, it does not add to them. 

 

""" 

from copy import deepcopy 

 

from ipalib import api, crud, errors 

from ipalib import Object, Command 

from ipalib import Flag, Int, Str, StrEnum 

from ipalib.aci import ACI 

from ipalib.dn import DN 

from ipalib import output 

from ipalib import _, ngettext 

from ipalib.plugins.baseldap import gen_pkey_only_option 

if api.env.in_server and api.env.context in ['lite', 'server']: 

    from ldap import explode_dn 

from ipapython.ipa_log_manager import * 

 

ACI_NAME_PREFIX_SEP = ":" 

 

_type_map = { 

    'user': 'ldap:///uid=*,%s,%s' % (api.env.container_user, api.env.basedn), 

    'group': 'ldap:///cn=*,%s,%s' % (api.env.container_group, api.env.basedn), 

    'host': 'ldap:///fqdn=*,%s,%s' % (api.env.container_host, api.env.basedn), 

    'hostgroup': 'ldap:///cn=*,%s,%s' % (api.env.container_hostgroup, api.env.basedn), 

    'service': 'ldap:///krbprincipalname=*,%s,%s' % (api.env.container_service, api.env.basedn), 

    'netgroup': 'ldap:///ipauniqueid=*,%s,%s' % (api.env.container_netgroup, api.env.basedn), 

    'dnsrecord': 'ldap:///idnsname=*,%s,%s' % (api.env.container_dns, api.env.basedn), 

} 

 

_valid_permissions_values = [ 

    u'read', u'write', u'add', u'delete', u'all' 

] 

 

_valid_prefix_values = ( 

    u'permission', u'delegation', u'selfservice', u'none' 

) 

 

class ListOfACI(output.Output): 

    type = (list, tuple) 

    doc = _('A list of ACI values') 

 

    def validate(self, cmd, entries): 

        assert isinstance(entries, self.type) 

        for (i, entry) in enumerate(entries): 

            if not isinstance(entry, unicode): 

                raise TypeError(output.emsg % 

                    (cmd.name, self.__class__.__name__, 

                    self.name, i, unicode, type(entry), entry) 

                ) 

 

aci_output = ( 

    output.Output('result', unicode, 'A string representing the ACI'), 

    output.value, 

    output.summary, 

) 

 

 

def _make_aci_name(aciprefix, aciname): 

    """ 

    Given a name and a prefix construct an ACI name. 

    """ 

    if aciprefix == u"none": 

        return aciname 

 

    return aciprefix + ACI_NAME_PREFIX_SEP + aciname 

 

def _parse_aci_name(aciname): 

    """ 

    Parse the raw ACI name and return a tuple containing the ACI prefix 

    and the actual ACI name. 

    """ 

    aciparts = aciname.partition(ACI_NAME_PREFIX_SEP) 

 

    if not aciparts[2]: # no prefix/name separator found 

        return (u"none",aciparts[0]) 

 

    return (aciparts[0], aciparts[2]) 

 

def _group_from_memberof(memberof): 

    """ 

    Pull the group name out of a memberOf filter 

    """ 

    st = memberof.find('memberOf=') 

    if st == -1: 

        # We have a raw group name, use that 

        return api.Object['group'].get_dn(memberof) 

    en = memberof.find(')', st) 

    return memberof[st+9:en] 

 

def _make_aci(ldap, current, aciname, kw): 

    """ 

    Given a name and a set of keywords construct an ACI. 

    """ 

    # Do some quick and dirty validation. 

    checked_args=['type','filter','subtree','targetgroup','attrs','memberof'] 

    valid={} 

    for arg in checked_args: 

        if arg in kw: 

            valid[arg]=kw[arg] is not None 

        else: 

            valid[arg]=False 

 

    if valid['type'] + valid['filter'] + valid['subtree'] + valid['targetgroup'] > 1: 

        raise errors.ValidationError(name='target', error=_('type, filter, subtree and targetgroup are mutually exclusive')) 

 

    if 'aciprefix' not in kw: 

        raise errors.ValidationError(name='aciprefix', error=_('ACI prefix is required')) 

 

    if sum(valid.itervalues()) == 0: 

        raise errors.ValidationError(name='target', error=_('at least one of: type, filter, subtree, targetgroup, attrs or memberof are required')) 

 

    if valid['filter'] + valid['memberof'] > 1: 

        raise errors.ValidationError(name='target', error=_('filter and memberof are mutually exclusive')) 

 

    group = 'group' in kw 

    permission = 'permission' in kw 

    selfaci = 'selfaci' in kw and kw['selfaci'] == True 

    if group + permission + selfaci > 1: 

        raise errors.ValidationError(name='target', error=_('group, permission and self are mutually exclusive')) 

    elif group + permission + selfaci == 0: 

        raise errors.ValidationError(name='target', error=_('One of group, permission or self is required')) 

 

    # Grab the dn of the group we're granting access to. This group may be a 

    # permission or a user group. 

    entry_attrs = [] 

    if permission: 

        # This will raise NotFound if the permission doesn't exist 

        try: 

            entry_attrs = api.Command['permission_show'](kw['permission'])['result'] 

        except errors.NotFound, e: 

            if 'test' in kw and not kw.get('test'): 

                raise e 

            else: 

                entry_attrs = {'dn': 'cn=%s,%s' % (kw['permission'], api.env.container_permission)} 

    elif group: 

        # Not so friendly with groups. This will raise 

        try: 

            entry_attrs = api.Command['group_show'](kw['group'])['result'] 

        except errors.NotFound: 

            raise errors.NotFound(reason=_("Group '%s' does not exist") % kw['group']) 

 

    try: 

        a = ACI(current) 

        a.name = _make_aci_name(kw['aciprefix'], aciname) 

        a.permissions = kw['permissions'] 

        if 'selfaci' in kw and kw['selfaci']: 

            a.set_bindrule('userdn = "ldap:///self"') 

        else: 

            dn = entry_attrs['dn'] 

            a.set_bindrule('groupdn = "ldap:///%s"' % dn) 

        if valid['attrs']: 

            a.set_target_attr(kw['attrs']) 

        if valid['memberof']: 

            try: 

                api.Command['group_show'](kw['memberof']) 

            except errors.NotFound: 

                api.Object['group'].handle_not_found(kw['memberof']) 

            groupdn = _group_from_memberof(kw['memberof']) 

            a.set_target_filter('memberOf=%s' % groupdn) 

        if valid['filter']: 

            # Test the filter by performing a simple search on it. The 

            # filter is considered valid if either it returns some entries 

            # or it returns no entries, otherwise we let whatever exception 

            # happened be raised. 

            if kw['filter'] in ('', None, u''): 

                raise errors.BadSearchFilter(info=_('empty filter')) 

            try: 

                entries = ldap.find_entries(filter=kw['filter']) 

            except errors.NotFound: 

                pass 

            a.set_target_filter(kw['filter']) 

        if valid['type']: 

            target = _type_map[kw['type']] 

            a.set_target(target) 

        if valid['targetgroup']: 

            # Purposely no try here so we'll raise a NotFound 

            entry_attrs = api.Command['group_show'](kw['targetgroup'])['result'] 

            target = 'ldap:///%s' % entry_attrs['dn'] 

            a.set_target(target) 

        if valid['subtree']: 

            # See if the subtree is a full URI 

            target = kw['subtree'] 

            if not target.startswith('ldap:///'): 

                target = 'ldap:///%s' % target 

            a.set_target(target) 

    except SyntaxError, e: 

        raise errors.ValidationError(name='target', error=_('Syntax Error: %(error)s') % dict(error=str(e))) 

 

    return a 

 

def _aci_to_kw(ldap, a, test=False, pkey_only=False): 

    """Convert an ACI into its equivalent keywords. 

 

       This is used for the modify operation so we can merge the 

       incoming kw and existing ACI and pass the result to 

       _make_aci(). 

    """ 

    kw = {} 

    kw['aciprefix'], kw['aciname'] = _parse_aci_name(a.name) 

    if pkey_only: 

        return kw 

    kw['permissions'] = tuple(a.permissions) 

    if 'targetattr' in a.target: 

        kw['attrs'] = list(a.target['targetattr']['expression']) 

        for i in xrange(len(kw['attrs'])): 

            kw['attrs'][i] = unicode(kw['attrs'][i]) 

        kw['attrs'] = tuple(kw['attrs']) 

    if 'targetfilter' in a.target: 

        target = a.target['targetfilter']['expression'] 

        if target.startswith('(memberOf=') or target.startswith('memberOf='): 

            (junk, memberof) = target.split('memberOf=', 1) 

            memberof = DN(memberof) 

            kw['memberof'] = memberof['cn'] 

        else: 

            kw['filter'] = unicode(target) 

    if 'target' in a.target: 

        target = a.target['target']['expression'] 

        found = False 

        for k in _type_map.keys(): 

            if _type_map[k] == target: 

                kw['type'] = unicode(k) 

                found = True 

                break; 

        if not found: 

            if target.startswith('('): 

                kw['filter'] = unicode(target) 

            else: 

                # See if the target is a group. If so we set the 

                # targetgroup attr, otherwise we consider it a subtree 

                if api.env.container_group in target: 

                    targetdn = unicode(target.replace('ldap:///','')) 

                    target = DN(targetdn) 

                    kw['targetgroup'] = target['cn'] 

                else: 

                    kw['subtree'] = unicode(target) 

 

    groupdn = a.bindrule['expression'] 

    groupdn = groupdn.replace('ldap:///','') 

    if groupdn == 'self': 

        kw['selfaci'] = True 

    elif groupdn == 'anyone': 

        pass 

    else: 

        if groupdn.startswith('cn='): 

            dn = '' 

            entry_attrs = {} 

            try: 

                (dn, entry_attrs) = ldap.get_entry(groupdn, ['cn']) 

            except errors.NotFound, e: 

                # FIXME, use real name here 

                if test: 

                    dn = 'cn=%s,%s' % ('test', api.env.container_permission) 

                    entry_attrs = {'cn': [u'test']} 

            if api.env.container_permission in dn: 

                kw['permission'] = entry_attrs['cn'][0] 

            else: 

                if 'cn' in entry_attrs: 

                    kw['group'] = entry_attrs['cn'][0] 

 

    return kw 

 

def _convert_strings_to_acis(acistrs): 

    acis = [] 

    for a in acistrs: 

        try: 

            acis.append(ACI(a)) 

        except SyntaxError, e: 

            root_logger.warning("Failed to parse: %s" % a) 

    return acis 

 

def _find_aci_by_name(acis, aciprefix, aciname): 

    name = _make_aci_name(aciprefix, aciname).lower() 

    for a in acis: 

        if a.name.lower() == name: 

            return a 

    raise errors.NotFound(reason=_('ACI with name "%s" not found') % aciname) 

 

def validate_permissions(ugettext, permissions): 

    valid_permissions = [] 

    permissions = permissions.split(',') 

    for p in permissions: 

        p = p.strip().lower() 

        if not p in _valid_permissions_values: 

             return '"%s" is not a valid permission' % p 

 

def _normalize_permissions(permissions): 

    valid_permissions = [] 

    permissions = permissions.split(',') 

    for p in permissions: 

        p = p.strip().lower() 

        if p not in valid_permissions: 

            valid_permissions.append(p) 

    return ','.join(valid_permissions) 

 

_prefix_option = StrEnum('aciprefix', 

                cli_name='prefix', 

                label=_('ACI prefix'), 

                doc=_('Prefix used to distinguish ACI types ' \ 

                    '(permission, delegation, selfservice, none)'), 

                values=_valid_prefix_values, 

                ) 

 

class aci(Object): 

    """ 

    ACI object. 

    """ 

    NO_CLI = True 

 

    label = _('ACIs') 

 

    takes_params = ( 

        Str('aciname', 

            cli_name='name', 

            label=_('ACI name'), 

            primary_key=True, 

            flags=('virtual_attribute',), 

        ), 

        Str('permission?', 

            cli_name='permission', 

            label=_('Permission'), 

            doc=_('Permission ACI grants access to'), 

            flags=('virtual_attribute',), 

        ), 

        Str('group?', 

            cli_name='group', 

            label=_('User group'), 

            doc=_('User group ACI grants access to'), 

            flags=('virtual_attribute',), 

        ), 

        Str('permissions+', validate_permissions, 

            cli_name='permissions', 

            label=_('Permissions'), 

            doc=_('comma-separated list of permissions to grant' \ 

                '(read, write, add, delete, all)'), 

            csv=True, 

            normalizer=_normalize_permissions, 

            flags=('virtual_attribute',), 

        ), 

        Str('attrs*', 

            cli_name='attrs', 

            label=_('Attributes'), 

            doc=_('Comma-separated list of attributes'), 

            csv=True, 

            flags=('virtual_attribute',), 

        ), 

        StrEnum('type?', 

            cli_name='type', 

            label=_('Type'), 

            doc=_('type of IPA object (user, group, host, hostgroup, service, netgroup)'), 

            values=(u'user', u'group', u'host', u'service', u'hostgroup', u'netgroup', u'dnsrecord'), 

            flags=('virtual_attribute',), 

        ), 

        Str('memberof?', 

            cli_name='memberof', 

            label=_('Member of'),  # FIXME: Does this label make sense? 

            doc=_('Member of a group'), 

            flags=('virtual_attribute',), 

        ), 

        Str('filter?', 

            cli_name='filter', 

            label=_('Filter'), 

            doc=_('Legal LDAP filter (e.g. ou=Engineering)'), 

            flags=('virtual_attribute',), 

        ), 

        Str('subtree?', 

            cli_name='subtree', 

            label=_('Subtree'), 

            doc=_('Subtree to apply ACI to'), 

            flags=('virtual_attribute',), 

        ), 

        Str('targetgroup?', 

            cli_name='targetgroup', 

            label=_('Target group'), 

            doc=_('Group to apply ACI to'), 

            flags=('virtual_attribute',), 

        ), 

        Flag('selfaci?', 

             cli_name='self', 

             label=_('Target your own entry (self)'), 

             doc=_('Apply ACI to your own entry (self)'), 

             flags=('virtual_attribute',), 

        ), 

    ) 

 

api.register(aci) 

 

class aci_add(crud.Create): 

    """ 

    Create new ACI. 

    """ 

    NO_CLI = True 

    msg_summary = _('Created ACI "%(value)s"') 

 

    takes_options = ( 

        _prefix_option, 

        Flag('test?', 

             doc=_('Test the ACI syntax but don\'t write anything'), 

             default=False, 

        ), 

    ) 

 

    def execute(self, aciname, **kw): 

        """ 

        Execute the aci-create operation. 

 

        Returns the entry as it will be created in LDAP. 

 

        :param aciname: The name of the ACI being added. 

        :param kw: Keyword arguments for the other LDAP attributes. 

        """ 

        assert 'aciname' not in kw 

        ldap = self.api.Backend.ldap2 

 

        newaci = _make_aci(ldap, None, aciname, kw) 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acis = _convert_strings_to_acis(entry_attrs.get('aci', [])) 

        for a in acis: 

            # FIXME: add check for permission_group = permission_group 

            if a.isequal(newaci) or newaci.name == a.name: 

                raise errors.DuplicateEntry() 

 

        newaci_str = unicode(newaci) 

        entry_attrs['aci'].append(newaci_str) 

 

        if not kw.get('test', False): 

            ldap.update_entry(dn, entry_attrs) 

 

        if kw.get('raw', False): 

            result = dict(aci=unicode(newaci_str)) 

        else: 

            result = _aci_to_kw(ldap, newaci, kw.get('test', False)) 

        return dict( 

            result=result, 

            value=aciname, 

        ) 

 

api.register(aci_add) 

 

 

class aci_del(crud.Delete): 

    """ 

    Delete ACI. 

    """ 

    NO_CLI = True 

    has_output = output.standard_boolean 

    msg_summary = _('Deleted ACI "%(value)s"') 

 

    takes_options = (_prefix_option,) 

 

    def execute(self, aciname, aciprefix): 

        """ 

        Execute the aci-delete operation. 

 

        :param aciname: The name of the ACI being deleted. 

        :param aciprefix: The ACI prefix. 

        """ 

        ldap = self.api.Backend.ldap2 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acistrs = entry_attrs.get('aci', []) 

        acis = _convert_strings_to_acis(acistrs) 

        aci = _find_aci_by_name(acis, aciprefix, aciname) 

        for a in acistrs: 

            candidate = ACI(a) 

            if aci.isequal(candidate): 

                acistrs.remove(a) 

                break 

 

        entry_attrs['aci'] = acistrs 

 

        ldap.update_entry(dn, entry_attrs) 

 

        return dict( 

            result=True, 

            value=aciname, 

        ) 

 

api.register(aci_del) 

 

 

class aci_mod(crud.Update): 

    """ 

    Modify ACI. 

    """ 

    NO_CLI = True 

    has_output_params = ( 

        Str('aci', 

            label=_('ACI'), 

        ), 

    ) 

 

    takes_options = (_prefix_option,) 

 

    msg_summary = _('Modified ACI "%(value)s"') 

 

    def execute(self, aciname, **kw): 

        aciprefix = kw['aciprefix'] 

        ldap = self.api.Backend.ldap2 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acis = _convert_strings_to_acis(entry_attrs.get('aci', [])) 

        aci = _find_aci_by_name(acis, aciprefix, aciname) 

 

        # The strategy here is to convert the ACI we're updating back into 

        # a series of keywords. Then we replace any keywords that have been 

        # updated and convert that back into an ACI and write it out. 

        oldkw = _aci_to_kw(ldap, aci) 

        newkw = deepcopy(oldkw) 

        if newkw.get('selfaci', False): 

            # selfaci is set in aci_to_kw to True only if the target is self 

            kw['selfaci'] = True 

        newkw.update(kw) 

        for acikw in (oldkw, newkw): 

            acikw.pop('aciname', None) 

 

        # _make_aci is what is run in aci_add and validates the input. 

        # Do this before we delete the existing ACI. 

        newaci = _make_aci(ldap, None, aciname, newkw) 

        if aci.isequal(newaci): 

            raise errors.EmptyModlist() 

 

        self.api.Command['aci_del'](aciname, aciprefix=aciprefix) 

 

        try: 

            result = self.api.Command['aci_add'](aciname, **newkw)['result'] 

        except Exception, e: 

            # ACI could not be added, try to restore the old deleted ACI and 

            # report the ADD error back to user 

            try: 

                self.api.Command['aci_add'](aciname, **oldkw) 

            except Exception: 

                pass 

            raise e 

 

        if kw.get('raw', False): 

            result = dict(aci=unicode(newaci)) 

        else: 

            result = _aci_to_kw(ldap, newaci) 

        return dict( 

            result=result, 

            value=aciname, 

        ) 

 

api.register(aci_mod) 

 

 

class aci_find(crud.Search): 

    """ 

    Search for ACIs. 

 

    Returns a list of ACIs 

 

    EXAMPLES: 

 

     To find all ACIs that apply directly to members of the group ipausers: 

       ipa aci-find --memberof=ipausers 

 

     To find all ACIs that grant add access: 

       ipa aci-find --permissions=add 

 

    Note that the find command only looks for the given text in the set of 

    ACIs, it does not evaluate the ACIs to see if something would apply. 

    For example, searching on memberof=ipausers will find all ACIs that 

    have ipausers as a memberof. There may be other ACIs that apply to 

    members of that group indirectly. 

    """ 

    NO_CLI = True 

    msg_summary = ngettext('%(count)d ACI matched', '%(count)d ACIs matched', 0) 

 

    takes_options = (_prefix_option.clone_rename("aciprefix?", required=False), 

                     gen_pkey_only_option("name"),) 

 

    def execute(self, term, **kw): 

        ldap = self.api.Backend.ldap2 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acis = _convert_strings_to_acis(entry_attrs.get('aci', [])) 

        results = [] 

 

        if term: 

            term = term.lower() 

            for a in acis: 

                if a.name.lower().find(term) != -1 and a not in results: 

                    results.append(a) 

            acis = list(results) 

        else: 

            results = list(acis) 

 

        if kw.get('aciname'): 

            for a in acis: 

                prefix, name = _parse_aci_name(a.name) 

                if name != kw['aciname']: 

                    results.remove(a) 

            acis = list(results) 

 

        if kw.get('aciprefix'): 

            for a in acis: 

                prefix, name = _parse_aci_name(a.name) 

                if prefix != kw['aciprefix']: 

                    results.remove(a) 

            acis = list(results) 

 

        if kw.get('attrs'): 

            for a in acis: 

                if not 'targetattr' in a.target: 

                    results.remove(a) 

                    continue 

                alist1 = sorted( 

                    [t.lower() for t in a.target['targetattr']['expression']] 

                ) 

                alist2 = sorted([t.lower() for t in kw['attrs']]) 

                if len(set(alist1) & set(alist2)) != len(alist2): 

                    results.remove(a) 

            acis = list(results) 

 

        if kw.get('permission'): 

            try: 

                self.api.Command['permission_show']( 

                    kw['permission'] 

                ) 

            except errors.NotFound: 

                pass 

            else: 

                for a in acis: 

                    if a.bindrule['expression'] != ('ldap:///%s' % dn): 

                        results.remove(a) 

                acis = list(results) 

 

        if kw.get('permissions'): 

            for a in acis: 

                alist1 = sorted(a.permissions) 

                alist2 = sorted(kw['permissions']) 

                if len(set(alist1) & set(alist2)) != len(alist2): 

                    results.remove(a) 

            acis = list(results) 

 

        if kw.get('memberof'): 

            try: 

                dn = _group_from_memberof(kw['memberof']) 

            except errors.NotFound: 

                pass 

            else: 

                memberof_filter = '(memberOf=%s)' % dn 

                for a in acis: 

                    if 'targetfilter' in a.target: 

                        targetfilter = a.target['targetfilter']['expression'] 

                        if targetfilter != memberof_filter: 

                            results.remove(a) 

                    else: 

                        results.remove(a) 

 

        if kw.get('type'): 

            for a in acis: 

                if 'target' in a.target: 

                    target = a.target['target']['expression'] 

                else: 

                    results.remove(a) 

                    continue 

                found = False 

                for k in _type_map.keys(): 

                    if _type_map[k] == target and kw['type'] == k: 

                        found = True 

                        break; 

                if not found: 

                    try: 

                        results.remove(a) 

                    except ValueError: 

                        pass 

 

        if kw.get('selfaci', False) is True: 

            for a in acis: 

                if a.bindrule['expression'] != u'ldap:///self': 

                    try: 

                        results.remove(a) 

                    except ValueError: 

                        pass 

 

        if kw.get('group'): 

            for a in acis: 

                groupdn = a.bindrule['expression'] 

                groupdn = groupdn.replace('ldap:///','') 

                cn = None 

                if groupdn.startswith('cn='): 

                    cn = explode_dn(groupdn)[0] 

                    cn = cn.replace('cn=','') 

                if cn is None or cn != kw['group']: 

                    try: 

                        results.remove(a) 

                    except ValueError: 

                        pass 

 

        if kw.get('targetgroup'): 

            for a in acis: 

                found = False 

                if 'target' in a.target: 

                    target = a.target['target']['expression'] 

                    if api.env.container_group in target: 

                        targetdn = unicode(target.replace('ldap:///','')) 

                        cn = explode_dn(targetdn)[0] 

                        cn = cn.replace('cn=','') 

                        if cn == kw['targetgroup']: 

                            found = True 

                if not found: 

                    try: 

                        results.remove(a) 

                    except ValueError: 

                        pass 

 

        if kw.get('filter'): 

            if not kw['filter'].startswith('('): 

                kw['filter'] = unicode('('+kw['filter']+')') 

            for a in acis: 

                if 'targetfilter' not in a.target or\ 

                    not a.target['targetfilter']['expression'] or\ 

                    a.target['targetfilter']['expression'] != kw['filter']: 

                    results.remove(a) 

 

        if kw.get('subtree'): 

            for a in acis: 

                if 'target' in a.target: 

                    target = a.target['target']['expression'] 

                else: 

                    results.remove(a) 

                    continue 

                if kw['subtree'].lower() != target.lower(): 

                    try: 

                        results.remove(a) 

                    except ValueError: 

                        pass 

 

        acis = [] 

        for result in results: 

            if kw.get('raw', False): 

                aci = dict(aci=unicode(result)) 

            else: 

                aci = _aci_to_kw(ldap, result, 

                        pkey_only=kw.get('pkey_only', False)) 

            acis.append(aci) 

 

        return dict( 

            result=acis, 

            count=len(acis), 

            truncated=False, 

        ) 

 

api.register(aci_find) 

 

 

class aci_show(crud.Retrieve): 

    """ 

    Display a single ACI given an ACI name. 

    """ 

    NO_CLI = True 

 

    has_output_params = ( 

        Str('aci', 

            label=_('ACI'), 

        ), 

    ) 

 

    takes_options = (_prefix_option,) 

 

    def execute(self, aciname, **kw): 

        """ 

        Execute the aci-show operation. 

 

        Returns the entry 

 

        :param uid: The login name of the user to retrieve. 

        :param kw: unused 

        """ 

        ldap = self.api.Backend.ldap2 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acis = _convert_strings_to_acis(entry_attrs.get('aci', [])) 

 

        aci = _find_aci_by_name(acis, kw['aciprefix'], aciname) 

        if kw.get('raw', False): 

            result = dict(aci=unicode(aci)) 

        else: 

            result = _aci_to_kw(ldap, aci) 

        return dict( 

            result=result, 

            value=aciname, 

        ) 

 

api.register(aci_show) 

 

 

class aci_rename(crud.Update): 

    """ 

    Rename an ACI. 

    """ 

    NO_CLI = True 

    has_output_params = ( 

        Str('aci', 

            label=_('ACI'), 

        ), 

    ) 

 

    takes_options = ( 

        _prefix_option, 

        Str('newname', 

             doc=_('New ACI name'), 

        ), 

    ) 

 

    msg_summary = _('Renamed ACI to "%(value)s"') 

 

    def execute(self, aciname, **kw): 

        ldap = self.api.Backend.ldap2 

 

        (dn, entry_attrs) = ldap.get_entry(self.api.env.basedn, ['aci']) 

 

        acis = _convert_strings_to_acis(entry_attrs.get('aci', [])) 

        aci = _find_aci_by_name(acis, kw['aciprefix'], aciname) 

 

        for a in acis: 

            prefix, name = _parse_aci_name(a.name) 

            if _make_aci_name(prefix, kw['newname']) == a.name: 

                raise errors.DuplicateEntry() 

 

        # The strategy here is to convert the ACI we're updating back into 

        # a series of keywords. Then we replace any keywords that have been 

        # updated and convert that back into an ACI and write it out. 

        newkw =  _aci_to_kw(ldap, aci) 

        if 'selfaci' in newkw and newkw['selfaci'] == True: 

            # selfaci is set in aci_to_kw to True only if the target is self 

            kw['selfaci'] = True 

        if 'aciname' in newkw: 

            del newkw['aciname'] 

 

        # _make_aci is what is run in aci_add and validates the input. 

        # Do this before we delete the existing ACI. 

        newaci = _make_aci(ldap, None, kw['newname'], newkw) 

 

        self.api.Command['aci_del'](aciname, aciprefix=kw['aciprefix']) 

 

        result = self.api.Command['aci_add'](kw['newname'], **newkw)['result'] 

 

        if kw.get('raw', False): 

            result = dict(aci=unicode(newaci)) 

        else: 

            result = _aci_to_kw(ldap, newaci) 

        return dict( 

            result=result, 

            value=kw['newname'], 

        ) 

 

api.register(aci_rename)