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
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ptr::NonNull;
#[cfg(feature = "objc2-core-foundation")]
use objc2_core_foundation::*;
use crate::*;
#[cfg(feature = "objc2-core-foundation")]
unsafe impl ConcreteType for ODRecordRef {
/// Standard GetTypeID function support for CF-based objects
///
/// Returns the typeID for the ODRecord object
///
/// Returns: a valid CFTypeID for the ODRecord object
#[doc(alias = "ODRecordGetTypeID")]
#[inline]
fn type_id() -> CFTypeID {
extern "C-unwind" {
fn ODRecordGetTypeID() -> CFTypeID;
}
unsafe { ODRecordGetTypeID() }
}
}
impl ODRecordRef {
/// Similar to calling ODNodeSetCredentials except credentials are only set for this particular record's node
///
/// Sets the credentials if necessary on the ODNodeRef referenced by this ODRecordRef. Very similar to
/// calling ODNodeSetCredentials except other records referencing the underlying ODNodeRef will not get
/// authenticated, therefore inadvertant changes cannot occur. If all records referencing a particular
/// ODNodeRef need to be updated, then use ODNodeSetCredentials on the original ODNodeRef instead. If the
/// ODNodeRef is already authenticated with the same name and password, this will be a NOOP call. The original
/// ODNodeRef held by an ODRecordRef will be released and a new ODNodeRef will be created when the credentials
/// are set for this ODRecordRef. Calling this on multiple records could result in multiple References into the
/// OpenDirectory daemon, which could cause errors logged into /var/log/system.log if a threshold is reached.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `username`: a CFStringRef of the username used to authenticate
///
/// Parameter `password`: a CFStringRef of the password used to authenticate
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details. Upon failure the original node
/// will still be intact.
///
/// # Safety
///
/// - `username` might not allow `None`.
/// - `password` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetNodeCredentials")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn set_node_credentials(
&self,
username: Option<&CFString>,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetNodeCredentials(
record: &ODRecordRef,
username: Option<&CFString>,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetNodeCredentials(self, username, password, error) }
}
/// Similar to calling ODNodeSetCredentialsExtended except credentials are only set for this particular record's
/// node
///
/// Allows the caller to use other types of authentications that are available in Open Directory, that may
/// require response-request loops, etc. Not all OD plugins will support this call, look for
/// kODErrorCredentialsMethodNotSupported in outError. Same behavior as ODRecordSetNodeCredentials.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `recordType`: a ODRecordTypeRef of the type of record to do the authentication with
///
/// Parameter `authType`: a ODAuthenticationTypeRef of the type of authentication to be used (e.g., kDSStdAuthNTLMv2)
///
/// Parameter `authItems`: a CFArrayRef of CFData or CFString items that will be sent in order to the auth process
///
/// Parameter `outAuthItems`: a pointer to CFArrayRef that will be assigned to a CFArrayRef of CFData items if the
/// call returned any values followup values
///
/// Parameter `outContext`: a pointer to ODContextRef if the call requires further calls for response-request auths.
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a bool will be returned with the result of the operation and outAuthItems set with response items
/// and outContext set for any needed continuation. Upon failure the original node will still be intact.
///
/// # Safety
///
/// - `record_type` might not allow `None`.
/// - `auth_type` might not allow `None`.
/// - `auth_items` generic must be of the correct type.
/// - `auth_items` might not allow `None`.
/// - `out_auth_items` must be a valid pointer.
/// - `out_context` must be a valid pointer.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetNodeCredentialsExtended")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn set_node_credentials_extended(
&self,
record_type: Option<&ODRecordType>,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetNodeCredentialsExtended(
record: &ODRecordRef,
record_type: Option<&ODRecordType>,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool;
}
unsafe {
ODRecordSetNodeCredentialsExtended(
self,
record_type,
auth_type,
auth_items,
out_auth_items,
out_context,
error,
)
}
}
/// Unsupported function.
///
/// Unsupported function.
///
/// # Safety
///
/// - `cache_name` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetNodeCredentialsUsingKerberosCache")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated]
#[inline]
pub unsafe fn set_node_credentials_using_kerberos_cache(
&self,
cache_name: Option<&CFString>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetNodeCredentialsUsingKerberosCache(
record: &ODRecordRef,
cache_name: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetNodeCredentialsUsingKerberosCache(self, cache_name, error) }
}
/// Returns a CFDictionaryRef of the effective policy for the user if available
///
/// Returns a CFDictionaryRef of the effective policy for the user if available
///
/// Parameter `allocator`: a CFAllocatorRef to use
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFDictionaryRef of the password policies for the supplied record, or NULL if no policy set
///
/// # Safety
///
/// - `allocator` might not allow `None`.
/// - `record` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyPasswordPolicy")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "use ODRecordCopyEffectivePolicies"]
#[inline]
pub unsafe fn password_policy(
allocator: Option<&CFAllocator>,
record: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyPasswordPolicy(
allocator: Option<&CFAllocator>,
record: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyPasswordPolicy(allocator, record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// Verifies the password provided is valid for the record
///
/// Verifies the password provided is valid for the record.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `password`: a CFStringRef of the password that is being verified
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `password` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordVerifyPassword")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn verify_password(
&self,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordVerifyPassword(
record: &ODRecordRef,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordVerifyPassword(self, password, error) }
}
/// Allows use of other Open Directory types of authentications to verify a record password
///
/// Allows the caller to use other types of authentications that are available in Open Directory, that may
/// require response-request loops, etc.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `authType`: a ODAuthenticationTypeRef of the type of authentication to be used (e.g., kODAuthenticationTypeCRAM_MD5)
///
/// Parameter `authItems`: a CFArrayRef of CFData or CFString items that will be sent in order to the auth process
///
/// Parameter `outAuthItems`: a pointer to CFArrayRef that will be assigned to a CFArrayRef of CFData items if the
/// call returned any values followup values
///
/// Parameter `outContext`: a pointer to ODContextRef if the call requires further calls for response-request auths.
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a bool will be returned with the result of the operation and outAuthItems set with response items
/// and outContext set for any needed continuation. Some ODNodes may not support the call so an error of
/// eNotHandledByThisNode or eNotYetImplemented may be returned.
///
/// # Safety
///
/// - `auth_type` might not allow `None`.
/// - `auth_items` generic must be of the correct type.
/// - `auth_items` might not allow `None`.
/// - `out_auth_items` must be a valid pointer.
/// - `out_context` must be a valid pointer.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordVerifyPasswordExtended")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn verify_password_extended(
&self,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordVerifyPasswordExtended(
record: &ODRecordRef,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool;
}
unsafe {
ODRecordVerifyPasswordExtended(
self,
auth_type,
auth_items,
out_auth_items,
out_context,
error,
)
}
}
/// Changes the password of an ODRecord
///
/// Changes the password of an ODRecord. If NULL is passed into inOldPassword, then an attempt to set
/// the password will be tried. If changing a password, then both old and new passwords should be supplied.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `oldPassword`: a CFString of the record's old password (NULL is optional).
///
/// Parameter `newPassword`: a CFString of the record's new password
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `old_password` might not allow `None`.
/// - `new_password` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordChangePassword")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn change_password(
&self,
old_password: Option<&CFString>,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordChangePassword(
record: &ODRecordRef,
old_password: Option<&CFString>,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordChangePassword(self, old_password, new_password, error) }
}
/// Returns the record type of an ODRecordRef
///
/// Returns the record type of an ODRecordRef
///
/// Parameter `record`: an ODRecordRef to use
///
/// Returns: a CFStringRef of the record type for this ODRecordRef
#[doc(alias = "ODRecordGetRecordType")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn record_type(&self) -> Option<CFRetained<CFString>> {
extern "C-unwind" {
fn ODRecordGetRecordType(record: &ODRecordRef) -> Option<NonNull<CFString>>;
}
let ret = unsafe { ODRecordGetRecordType(self) };
ret.map(|ret| unsafe { CFRetained::retain(ret) })
}
/// Returns the official record name of an ODRecordRef
///
/// Returns the official record name of an ODRecordRef which typically corresponds to the first value
/// of the kODAttributeTypeRecordName attribute, but not always. This name should be a valid name in either case.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Returns: a CFStringRef of the record name for this ODRecordRef
#[doc(alias = "ODRecordGetRecordName")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn record_name(&self) -> Option<CFRetained<CFString>> {
extern "C-unwind" {
fn ODRecordGetRecordName(record: &ODRecordRef) -> Option<NonNull<CFString>>;
}
let ret = unsafe { ODRecordGetRecordName(self) };
ret.map(|ret| unsafe { CFRetained::retain(ret) })
}
/// Returns the value of an attribute as an array of CFStringRef or CFDataRef types
///
/// Returns the value of an attribute as an array of CFStringRef or CFDataRef, depending on
/// whether the data is Binary or not. If the value has been fetched from the directory previously
/// a copy of the internal storage will be returned without going to the directory. If it has not been fetched
/// previously, then it will be fetched at that time.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `attribute`: a CFStringRef or ODAttributeType of the attribute (e.g., kODAttributeTypeRecordName, etc.)
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFArrayRef of the attribute requested if possible, or NULL if the attribute doesn't exist
///
/// # Safety
///
/// - `attribute` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyValues")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn values(
&self,
attribute: Option<&ODAttributeType>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFArray>> {
extern "C-unwind" {
fn ODRecordCopyValues(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
error: *mut *mut CFError,
) -> Option<NonNull<CFArray>>;
}
let ret = unsafe { ODRecordCopyValues(self, attribute, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// Will take a CFDataRef or CFStringRef or a CFArrayRef of either type and set it for the attribute
///
/// Will take a CFDataRef or CFStringRef or a CFArrayRef of either type and set it for the attribute.
/// Any mixture of the types CFData and CFString are accepted.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `attribute`: a CFStringRef of the attribute for values to be added too
///
/// Parameter `valueOrValues`: a CFArrayRef of CFStringRef or CFDataRef types or either of the individual types, passing
/// an empty CFArray deletes the attribute. The underlying implementation will do this in the most efficient manner,
/// either by adding only new values or completely replacing the values depending on the capabilities of the
/// particular plugin.
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `attribute` might not allow `None`.
/// - `value_or_values` should be of the correct type.
/// - `value_or_values` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetValue")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn set_value(
&self,
attribute: Option<&ODAttributeType>,
value_or_values: Option<&CFType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value_or_values: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetValue(self, attribute, value_or_values, error) }
}
/// Adds a value to an attribute
///
/// Adds a value to an attribute.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `attribute`: a CFStringRef of the attribute for values to be added too
///
/// Parameter `value`: a CFTypeRef of the value to be added to the attribute, either CFStringRef or CFDataRef
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `attribute` might not allow `None`.
/// - `value` should be of the correct type.
/// - `value` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordAddValue")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn add_value(
&self,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordAddValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordAddValue(self, attribute, value, error) }
}
/// Removes a particular value from an attribute.
///
/// Removes a particular value from an attribute.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `attribute`: a CFStringRef of the attribute to remove the value from
///
/// Parameter `value`: a CFTypeRef of the value to be removed from the attribute. Either CFStringRef or CFDataRef.
/// If the value does not exist, true will be returned and no error will be set.
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `attribute` might not allow `None`.
/// - `value` should be of the correct type.
/// - `value` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordRemoveValue")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn remove_value(
&self,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordRemoveValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordRemoveValue(self, attribute, value, error) }
}
/// Returns the attributes and values in the form of a key-value pair set for this record.
///
/// Returns the attributes and values in the form of a key-value pair set for this record. The key is a
/// CFStringRef or ODAttributeType of the attribute name (e.g., kODAttributeTypeRecordName, etc.) and the
/// value is an CFArrayRef of either CFDataRef or CFStringRef depending on the type of data. Binary data will
/// be returned as CFDataRef.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `attributes`: a CFArrayRef of attributes. If an attribute has not been fetched previously, it will be
/// fetched in order to return the value. If this parameter is NULL then all currently fetched attributes
/// will be returned.
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFDictionaryRef of the attributes for the record
///
/// # Safety
///
/// - `attributes` generic must be of the correct type.
/// - `attributes` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyDetails")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn details(
&self,
attributes: Option<&CFArray>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyDetails(
record: &ODRecordRef,
attributes: Option<&CFArray>,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyDetails(self, attributes, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// Synchronizes the record from the Directory in order to get current data and commit pending changes
///
/// Synchronizes the record from the Directory in order to get current data. Any previously fetched attributes
/// will be refetched from the Directory. This will not refetch the entire record, unless the entire record
/// has been accessed. Additionally, any changes made to the record will be committed to the directory
/// if the node does not do immediate commits.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordSynchronize")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn synchronize(&self, error: *mut *mut CFError) -> bool {
extern "C-unwind" {
fn ODRecordSynchronize(record: &ODRecordRef, error: *mut *mut CFError) -> bool;
}
unsafe { ODRecordSynchronize(self, error) }
}
/// Deletes the record from the node and invalidates the record.
///
/// Deletes the record from the node and invalidates the record. The ODRecordRef should be
/// released after deletion.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordDelete")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn delete(&self, error: *mut *mut CFError) -> bool {
extern "C-unwind" {
fn ODRecordDelete(record: &ODRecordRef, error: *mut *mut CFError) -> bool;
}
unsafe { ODRecordDelete(self, error) }
}
/// Will add the record as a member of the group record that is provided
///
/// Will add the record as a member of the group record that is provided in an appopriate manner
/// based on what the directory will store. An error will be returned if the record is not a group record.
/// Additionally, if the member record is not an appropriate type allowed as part of a group an
/// error will be returned.
///
/// Parameter `group`: an ODRecordRef of the group record to modify
///
/// Parameter `member`: an ODRecordRef of the record to add to the group record
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `member` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordAddMember")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn add_member(
&self,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordAddMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordAddMember(self, member, error) }
}
/// Will remove the record as a member from the group record that is provided
///
/// Will remove the record as a member from the group record that is provided. If the record type
/// of group is not a Group, false will be returned with an appropriate error.
///
/// Parameter `group`: an ODRecordRef of the group record to modify
///
/// Parameter `member`: an ODRecordRef of the record to remove from the group record
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true on success, otherwise outError can be checked for details
///
/// # Safety
///
/// - `member` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordRemoveMember")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn remove_member(
&self,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordRemoveMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordRemoveMember(self, member, error) }
}
/// Will use membership APIs to resolve group membership based on Group and Member record combination
///
/// Will use membership APIs to resolve group membership based on Group and Member record combination.
/// This API does not check attributes values directly, instead uses system APIs to deal with nested
/// memberships.
///
/// Parameter `group`: an ODRecordRef of the group to be checked for membership
///
/// Parameter `member`: an ODRecordRef of the member to be checked against the group
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: returns true or false depending on result
///
/// # Safety
///
/// - `member` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordContainsMember")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn contains_member(
&self,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordContainsMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordContainsMember(self, member, error) }
}
/// This will copy any policies configured for the record.
///
/// This will copy any policies configured for the record.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFDictionaryRef containing all currently configured policies
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyPolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "use ODRecordCopyAccountPolicies"]
#[inline]
pub unsafe fn policies(&self, error: *mut *mut CFError) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyPolicies(self, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// This will copy the effective policies for the record (merging any node-level policies).
///
/// This will copy the effective policies for the record (merging any node-level policies).
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFDictionaryRef containing all currently configured policies (merging any node-level policies)
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyEffectivePolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "use ODRecordAuthenticationAllowed and similar functions"]
#[inline]
pub unsafe fn effective_policies(
&self,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyEffectivePolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyEffectivePolicies(self, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// This will return a dictionary of supported policies.
///
/// This will return a dictionary of supported policies, if appropriate, the value will be the maximum value allowed
/// for the policy in question. For example, if password history is available, it will state how much history is
/// supported.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a CFDictionaryRef containing all currently supported policies
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordCopySupportedPolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated]
#[inline]
pub unsafe fn supported_policies(
&self,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopySupportedPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopySupportedPolicies(self, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// This will set the policy for the record.
///
/// This will set the policy for the record. Policies are evaluated in combination with node-level policies.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `policies`: a CFDictionary of policies to be set
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a bool which signifies if the policy set succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policies` generics must be of the correct type.
/// - `policies` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetPolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "use ODRecordSetAccountPolicies"]
#[inline]
pub unsafe fn set_policies(
&self,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetPolicies(
record: &ODRecordRef,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetPolicies(self, policies, error) }
}
/// This will set a specific policy setting for the record.
///
/// This will set a specific policy setting for the record.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `policy`: a valid ODPolicyType
///
/// Parameter `value`: a CFTypeRef to be set (should be of appropriate type for the policy)
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a bool which signifies if the policy set succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` might not allow `None`.
/// - `value` should be of the correct type.
/// - `value` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetPolicy")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "use ODRecordAddAccountPolicy"]
#[inline]
pub unsafe fn set_policy(
&self,
policy: Option<&ODPolicyType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetPolicy(
record: &ODRecordRef,
policy: Option<&ODPolicyType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetPolicy(self, policy, value, error) }
}
/// This will remove a specific policy setting from the record.
///
/// This will remove a specific policy setting from the record.
///
/// Parameter `record`: an ODRecordRef to use
///
/// Parameter `policy`: a valid ODPolicyType
///
/// Parameter `error`: an optional CFErrorRef reference for error details
///
/// Returns: a bool which signifies if the policy removal succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordRemovePolicy")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "use ODRecordRemoveAccountPolicy"]
#[inline]
pub unsafe fn remove_policy(
&self,
policy: Option<&ODPolicyType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordRemovePolicy(
record: &ODRecordRef,
policy: Option<&ODPolicyType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordRemovePolicy(self, policy, error) }
}
/// This will add an account policy to the record for the specified category.
///
/// This will add an account policy to the record for the specified category.
/// The node-level and record-level policies will be combined and
/// evaluated as appropriate, ensuring the strongest policy is enforced.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `policy`: a dictionary containing the specific policy to be added.
/// The dictionary may contain the following keys:
/// kODPolicyKeyIdentifier a required key identifying the policy.
/// kODPolicyKeyParameters an optional key containing a dictionary of
/// parameters that can be used for informational purposes or in
/// the policy format string.
/// kODPolicyKeyContent a required key specifying the policy,
/// from which a predicate will be created for evaluating
/// the policy.
///
/// Parameter `category`: a valid ODPolicyCategoryType to which the policy will be added.
///
/// Parameter `error`: is an optional CFErrorRef reference for error details.
///
/// Returns: a bool which signifies if the policy addition succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` generics must be of the correct type.
/// - `policy` might not allow `None`.
/// - `category` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordAddAccountPolicy")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn add_account_policy(
&self,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordAddAccountPolicy(
record: &ODRecordRef,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordAddAccountPolicy(self, policy, category, error) }
}
/// This will remove an account policy from the record for the specified category.
///
/// This will remove an account policy from the record for the specified category.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `policy`: a dictionary containing the specific policy to be
/// removed, with the same format as described in ODRecordAddAccountPolicy.
///
/// Parameter `category`: a valid ODPolicyCategoryType from which the policy will be removed.
///
/// Parameter `error`: an optional CFErrorRef reference for error details.
///
/// Returns: a bool which signifies if the policy removal succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policy` generics must be of the correct type.
/// - `policy` might not allow `None`.
/// - `category` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordRemoveAccountPolicy")]
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[inline]
pub unsafe fn remove_account_policy(
&self,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordRemoveAccountPolicy(
record: &ODRecordRef,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordRemoveAccountPolicy(self, policy, category, error) }
}
/// This will set the policies for the record.
///
/// This will set the policies for the record, replacing any
/// existing policies. All of the policies in the set will be
/// applied to the record when policies are evaluated.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `policies`: a dictionary containing all of the policies to be set
/// for the node. The dictionary may contain the following keys:
/// kODPolicyCategoryAuthentication an optional key with a value
/// of an array of policy dictionaries that specify when
/// authentications should be allowed.
/// kODPolicyCategoryPasswordContent an optional key with a
/// value of an array of policy dictionaries the specify the
/// required content of passwords.
/// kODPolicyCategoryPasswordChange an optional key with a value
/// of an array of policy dictionaries that specify when
/// passwords are required to be changed.
///
/// Parameter `error`: an optional CFErrorRef reference for error details.
///
/// Returns: a bool which signifies if the policy set succeeded, otherwise error is set.
///
/// # Safety
///
/// - `policies` generics must be of the correct type.
/// - `policies` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordSetAccountPolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn set_account_policies(
&self,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordSetAccountPolicies(
record: &ODRecordRef,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordSetAccountPolicies(self, policies, error) }
}
/// This will copy any policies configured for the record.
///
/// This will copy any policies configured for the record. Does not
/// copy any policies set for the node.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `error`: an optional CFErrorRef reference for error details.
///
/// Returns: a CFDictionaryRef containing all currently set policies. The
/// format of the dictionary is the same as described in
/// ODRecordSetAccountPolicies().
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordCopyAccountPolicies")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn account_policies(
&self,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyAccountPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyAccountPolicies(self, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
/// Determines if policies allow the account to authenticate.
///
/// Determines if policies allow the account to authenticate.
/// Authentication and password change policies are evaluated.
/// Record-level and node-level policies are evaluated in
/// combination, with record-level taking precedence over node-level
/// policies. The failure of any single policy will deny the
/// authentication.
///
/// This check is only definitive at the time it was requested. The
/// policy or the environment could change before the authentication
/// is actually requested. Errors from the authentication request
/// should be consulted.
///
/// It is not necessary to call this function when callingg
/// ODRecordVerifyPassword or ODRecordVerifyPasswordExtended
/// since those functions perform same policy evaluation.
///
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `error`: an optional CFErrorRef reference for error details.
///
/// Returns: a bool which signifies if the authentication is allowed, otherwise error is set.
///
/// # Safety
///
/// `error` must be a valid pointer.
#[doc(alias = "ODRecordAuthenticationAllowed")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn authentication_allowed(&self, error: *mut *mut CFError) -> bool {
extern "C-unwind" {
fn ODRecordAuthenticationAllowed(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordAuthenticationAllowed(self, error) }
}
/// Determines if policies allow the password change.
///
/// Determines if policies allow the password change. Password
/// content policies are evaluated. Record-level and node-level
/// policies are evaluated in combination, with record-level taking
/// precedence over node-level policies. The failure of any single
/// policy will deny the password change.
///
/// This check is only definitive at the time it was requested. The
/// policy or the environment could change before the password change
/// is actually requested. Errors from the password change request
/// should be consulted.
///
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `newPassword`: contains the password to be evaluated.
///
/// Parameter `error`: an optional CFErrorRef reference for error details.
///
/// Returns: a bool which signifies if the password change is allowed, otherwise error is set.
///
/// # Safety
///
/// - `new_password` might not allow `None`.
/// - `error` must be a valid pointer.
#[doc(alias = "ODRecordPasswordChangeAllowed")]
#[cfg(feature = "objc2-core-foundation")]
#[inline]
pub unsafe fn password_change_allowed(
&self,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool {
extern "C-unwind" {
fn ODRecordPasswordChangeAllowed(
record: &ODRecordRef,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
unsafe { ODRecordPasswordChangeAllowed(self, new_password, error) }
}
/// Determines if the password will expire within the specified time.
///
/// Determines if the password will expire (i.e. need to be changed)
/// between now and the specified number of seconds in the future.
/// Record-level and node-level policies are evaluated
/// together, with record-level taking precedence over node-level
/// policies.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `willExpireIn`: the number of seconds from the current time to be
/// used as the upper-bound for the password expiration period.
///
/// Returns: a bool which signifies if the password will expire within the
/// specified time.
#[doc(alias = "ODRecordWillPasswordExpire")]
#[inline]
pub unsafe fn will_password_expire(&self, will_expire_in: u64) -> bool {
extern "C-unwind" {
fn ODRecordWillPasswordExpire(record: &ODRecordRef, will_expire_in: u64) -> bool;
}
unsafe { ODRecordWillPasswordExpire(self, will_expire_in) }
}
/// Determines if authentications will expire within the specified time.
///
/// Determines if authentications will expire (i.e. session and/or
/// account expires) between now and the specified number of seconds
/// in the future. Record-level and node-level policies are evaluated
/// together, with record-level taking precedence over node-level
/// policies.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Parameter `willExpireIn`: the number of seconds from the current time to be
/// used as the upper-bound for the authentication expiration period.
///
/// Returns: a bool which signifies if authentications will expire within the
/// specified time.
#[doc(alias = "ODRecordWillAuthenticationsExpire")]
#[inline]
pub unsafe fn will_authentications_expire(&self, will_expire_in: u64) -> bool {
extern "C-unwind" {
fn ODRecordWillAuthenticationsExpire(record: &ODRecordRef, will_expire_in: u64)
-> bool;
}
unsafe { ODRecordWillAuthenticationsExpire(self, will_expire_in) }
}
/// Determines how many seconds until the password expires.
///
/// Determines how many seconds until the password expires (i.e.
/// needs changing). Password change policies are evaluated.
/// Record-level and node-level policies are evaluated in
/// combination, with record-level taking precedence over node-level
/// policies.
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Returns: the number of seconds until the password expires. If multiple
/// policies will cause the password to expire, the soonest
/// expiration time is returned. If already expired,
/// kODExpirationTimeExpired is returned. If there are no password
/// change policies, kODExpirationTimeNeverExpires is returned.
#[doc(alias = "ODRecordSecondsUntilPasswordExpires")]
#[inline]
pub unsafe fn seconds_until_password_expires(&self) -> i64 {
extern "C-unwind" {
fn ODRecordSecondsUntilPasswordExpires(record: &ODRecordRef) -> i64;
}
unsafe { ODRecordSecondsUntilPasswordExpires(self) }
}
/// Determines how many seconds until authentications expire.
///
/// Determines how many seconds until authentications expire (i.e.
/// session and/or account expires). Record-level and node-level
/// policies are evaluated together, with record-level taking
/// precedence over node-level policies
///
/// Parameter `record`: an ODRecordRef to use.
///
/// Returns: the number of seconds until authentications expire. If multiple
/// policies will cause authentications to expire, the soonest
/// expiration time is returned. If already expired,
/// kODExpirationTimeExpired is returned. If there are no
/// authentication policies controlling expiration,
/// kODExpirationTimeNeverExpires is returned.
#[doc(alias = "ODRecordSecondsUntilAuthenticationsExpire")]
#[inline]
pub unsafe fn seconds_until_authentications_expire(&self) -> i64 {
extern "C-unwind" {
fn ODRecordSecondsUntilAuthenticationsExpire(record: &ODRecordRef) -> i64;
}
unsafe { ODRecordSecondsUntilAuthenticationsExpire(self) }
}
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::set_node_credentials`"]
pub fn ODRecordSetNodeCredentials(
record: &ODRecordRef,
username: Option<&CFString>,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::set_node_credentials_extended`"]
pub fn ODRecordSetNodeCredentialsExtended(
record: &ODRecordRef,
record_type: Option<&ODRecordType>,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::set_node_credentials_using_kerberos_cache`"]
pub fn ODRecordSetNodeCredentialsUsingKerberosCache(
record: &ODRecordRef,
cache_name: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::password_policy`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyPasswordPolicy(
allocator: Option<&CFAllocator>,
record: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyPasswordPolicy(
allocator: Option<&CFAllocator>,
record: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyPasswordPolicy(allocator, record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::verify_password`"]
pub fn ODRecordVerifyPassword(
record: &ODRecordRef,
password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::verify_password_extended`"]
pub fn ODRecordVerifyPasswordExtended(
record: &ODRecordRef,
auth_type: Option<&ODAuthenticationType>,
auth_items: Option<&CFArray>,
out_auth_items: *mut *const CFArray,
out_context: *mut *const ODContextRef,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::change_password`"]
pub fn ODRecordChangePassword(
record: &ODRecordRef,
old_password: Option<&CFString>,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::record_type`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordGetRecordType(
record: &ODRecordRef,
) -> Option<CFRetained<CFString>> {
extern "C-unwind" {
fn ODRecordGetRecordType(record: &ODRecordRef) -> Option<NonNull<CFString>>;
}
let ret = unsafe { ODRecordGetRecordType(record) };
ret.map(|ret| unsafe { CFRetained::retain(ret) })
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::record_name`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordGetRecordName(
record: &ODRecordRef,
) -> Option<CFRetained<CFString>> {
extern "C-unwind" {
fn ODRecordGetRecordName(record: &ODRecordRef) -> Option<NonNull<CFString>>;
}
let ret = unsafe { ODRecordGetRecordName(record) };
ret.map(|ret| unsafe { CFRetained::retain(ret) })
}
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::values`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyValues(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFArray>> {
extern "C-unwind" {
fn ODRecordCopyValues(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
error: *mut *mut CFError,
) -> Option<NonNull<CFArray>>;
}
let ret = unsafe { ODRecordCopyValues(record, attribute, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::set_value`"]
pub fn ODRecordSetValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value_or_values: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::add_value`"]
pub fn ODRecordAddValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::remove_value`"]
pub fn ODRecordRemoveValue(
record: &ODRecordRef,
attribute: Option<&ODAttributeType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::details`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyDetails(
record: &ODRecordRef,
attributes: Option<&CFArray>,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyDetails(
record: &ODRecordRef,
attributes: Option<&CFArray>,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyDetails(record, attributes, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::synchronize`"]
pub fn ODRecordSynchronize(record: &ODRecordRef, error: *mut *mut CFError) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::delete`"]
pub fn ODRecordDelete(record: &ODRecordRef, error: *mut *mut CFError) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::add_member`"]
pub fn ODRecordAddMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::remove_member`"]
pub fn ODRecordRemoveMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::contains_member`"]
pub fn ODRecordContainsMember(
group: &ODRecordRef,
member: Option<&ODRecordRef>,
error: *mut *mut CFError,
) -> bool;
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::policies`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyPolicies(record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::effective_policies`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyEffectivePolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyEffectivePolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyEffectivePolicies(record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::supported_policies`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopySupportedPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopySupportedPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopySupportedPolicies(record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::set_policies`"]
pub fn ODRecordSetPolicies(
record: &ODRecordRef,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::set_policy`"]
pub fn ODRecordSetPolicy(
record: &ODRecordRef,
policy: Option<&ODPolicyType>,
value: Option<&CFType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::remove_policy`"]
pub fn ODRecordRemovePolicy(
record: &ODRecordRef,
policy: Option<&ODPolicyType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::add_account_policy`"]
pub fn ODRecordAddAccountPolicy(
record: &ODRecordRef,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(all(
feature = "CFOpenDirectoryConstants",
feature = "objc2-core-foundation"
))]
#[deprecated = "renamed to `ODRecordRef::remove_account_policy`"]
pub fn ODRecordRemoveAccountPolicy(
record: &ODRecordRef,
policy: Option<&CFDictionary>,
category: Option<&ODPolicyCategoryType>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::set_account_policies`"]
pub fn ODRecordSetAccountPolicies(
record: &ODRecordRef,
policies: Option<&CFDictionary>,
error: *mut *mut CFError,
) -> bool;
}
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::account_policies`"]
#[inline]
pub unsafe extern "C-unwind" fn ODRecordCopyAccountPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<CFRetained<CFDictionary>> {
extern "C-unwind" {
fn ODRecordCopyAccountPolicies(
record: &ODRecordRef,
error: *mut *mut CFError,
) -> Option<NonNull<CFDictionary>>;
}
let ret = unsafe { ODRecordCopyAccountPolicies(record, error) };
ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::authentication_allowed`"]
pub fn ODRecordAuthenticationAllowed(record: &ODRecordRef, error: *mut *mut CFError) -> bool;
}
extern "C-unwind" {
#[cfg(feature = "objc2-core-foundation")]
#[deprecated = "renamed to `ODRecordRef::password_change_allowed`"]
pub fn ODRecordPasswordChangeAllowed(
record: &ODRecordRef,
new_password: Option<&CFString>,
error: *mut *mut CFError,
) -> bool;
}
extern "C-unwind" {
#[deprecated = "renamed to `ODRecordRef::will_password_expire`"]
pub fn ODRecordWillPasswordExpire(record: &ODRecordRef, will_expire_in: u64) -> bool;
}
extern "C-unwind" {
#[deprecated = "renamed to `ODRecordRef::will_authentications_expire`"]
pub fn ODRecordWillAuthenticationsExpire(record: &ODRecordRef, will_expire_in: u64) -> bool;
}
extern "C-unwind" {
#[deprecated = "renamed to `ODRecordRef::seconds_until_password_expires`"]
pub fn ODRecordSecondsUntilPasswordExpires(record: &ODRecordRef) -> i64;
}
extern "C-unwind" {
#[deprecated = "renamed to `ODRecordRef::seconds_until_authentications_expire`"]
pub fn ODRecordSecondsUntilAuthenticationsExpire(record: &ODRecordRef) -> i64;
}