summaryrefslogtreecommitdiffstats
path: root/asn1/README
diff options
context:
space:
mode:
authorSimo Sorce <simo@redhat.com>2014-11-13 11:31:09 -0500
committerSimo Sorce <simo@redhat.com>2014-11-20 10:52:13 -0500
commitc6afc489a1c9d86fd593bd47c4a8dae6d9a008d2 (patch)
tree27ad9cc99e3c8e38b8df1adacb3cca5e3f8f1e43 /asn1/README
parentb170851058d6712442d553ef3d11ecd21b282443 (diff)
downloadfreeipa-c6afc489a1c9d86fd593bd47c4a8dae6d9a008d2.tar.gz
freeipa-c6afc489a1c9d86fd593bd47c4a8dae6d9a008d2.tar.xz
freeipa-c6afc489a1c9d86fd593bd47c4a8dae6d9a008d2.zip
Add asn1c generated code for keytab controls
Instead of manually encoding controls, use an actual asn1 compiler. The file asn1/asn1c/ipa.asn1 will contain ipa modules. The generated code is committed to the tree and built into a static library that is linked to the code that uses it. The first module implements the GetKeytabControl control. Related: https://fedorahosted.org/freeipa/ticket/4718 https://fedorahosted.org/freeipa/ticket/4728 Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com> Reviewed-By: Nathaniel McCallum <npmccallum@redhat.com>
Diffstat (limited to 'asn1/README')
-rw-r--r--asn1/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/asn1/README b/asn1/README
new file mode 100644
index 000000000..ec9752f56
--- /dev/null
+++ b/asn1/README
@@ -0,0 +1,17 @@
+libipaasn1.a is a small static convenience library used by other ipa
+binaries and modules. At the moment it is not meant to be a public shared
+library and stable interface, but may become one in future.
+
+The only files that should be manually modified are:
+* asn1c/ipa.asn1 - when new interfaces are added
+* ipa_asn1.[ch] - to add wrappers around interfaces
+
+ipa_asn1.[ch] are the public interface and they SHOULD NOT export generated
+structures so that the autogenerated code can change w/o impacting any other
+code except the internal library functions.
+
+To regenerate the automatically generated files run the following command:
+cd asn1c;
+make regenerate
+
+Remember to commit and add any new file to asn1c/Makefile.am