FS-3110 --comment-only phase 1 to replace udns with ldns in mod_enum may need to rerun bootstrap

2025-08-13 09:36:46 +00:00 · 2011-03-24 16:26:37 -05:00
parent 047110cd56
commit 1773b890eb
275 changed files with 115723 additions and 8338 deletions
--- a/libs/ldns/contrib/python/docs/source/modules/ldns.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns.rst
@@ -0,0 +1,40 @@
+LDNS module documentation
+================================
+
+Here you can find the documentation of pyLDNS extension module. This module consists of several classes and a couple of functions.
+
+.. toctree::
+	:maxdepth: 1
+	:glob:
+
+	ldns_resolver
+	ldns_pkt
+	ldns_rr
+	ldns_rdf
+	ldns_dname
+	ldns_rr_list
+	ldns_zone
+	ldns_key
+	ldns_key_list
+	ldns_buffer
+	ldns_dnssec
+	ldns_func
+
+
+
+
+**Differences against libLDNS**
+
+* You don't need to use ldns-compare functions, instances can be compared using standard operators <, >, = ::
+	
+	if (some_rr.owner() == another_rr.rdf(1)):
+		pass
+
+* Classes contain static methods that create new instances, the name of these methods starts with the new\_ prefix (e.g. :meth:`ldns.ldns_pkt.new_frm_file`).
+
+* Is it possible to print the content of an object using ``print objinst`` (see :meth:`ldns.ldns_resolver.get_addr_by_name`).
+
+* Classes contain write_to_buffer method that writes the content into buffer.
+
+* All the methods that consume parameter of (const ldns_rdf) type allows to use string instead (see :meth:`ldns.ldns_resolver.query`).
+
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_buffer.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_buffer.rst
@@ -0,0 +1,11 @@
+Class ldns_buffer
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_buffer
+------------------------------
+.. autoclass:: ldns_buffer
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_dname.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_dname.rst
@@ -0,0 +1,11 @@
+Class ldns_dname
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_dname
+------------------------------
+.. autoclass:: ldns_dname
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_dnssec.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_dnssec.rst
@@ -0,0 +1,28 @@
+Class ldns_dnssec_zone
+================================
+
+..	automodule:: ldns
+
+Class ldns_dnssec_zone
+------------------------------
+.. autoclass:: ldns_dnssec_zone
+	:members:
+	:undoc-members:
+
+Class ldns_dnssec_name
+------------------------------
+.. autoclass:: ldns_dnssec_name
+	:members:
+	:undoc-members:
+
+Class ldns_dnssec_rrsets
+------------------------------
+.. autoclass:: ldns_dnssec_rrsets
+	:members:
+	:undoc-members:
+
+Class ldns_dnssec_rrs
+------------------------------
+.. autoclass:: ldns_dnssec_rrs
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_func.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_func.rst
@@ -0,0 +1,253 @@
+Various functions
+================================
+
+Here you can find list of functions that are not assigned to the classes.
+These functions have the same parameters as LDNS functions of the same name.
+You are encouraged to read the LDNS documentation.
+
+**List of functions**
+
+  *  ldns_algorithm2buffer_str
+  *  ldns_bget_keyword_data
+  *  ldns_bget_token
+  *  ldns_bgetc
+  *  ldns_bskipcs
+  *  ldns_bubblebabble
+  *  ldns_buffer2pkt_wire
+  *  ldns_buffer2str
+  *  ldns_calc_keytag
+  *  ldns_calc_keytag_raw
+  *  ldns_cert_algorithm2buffer_str
+  *  ldns_convert_dsa_rrsig_asn12rdf
+  *  ldns_convert_dsa_rrsig_rdf2asn1
+  *  ldns_create_nsec
+  *  ldns_create_nsec3
+  *  ldns_dname2buffer_wire
+  *  ldns_dname2canonical
+  *  ldns_dnssec_build_data_chain
+  *  ldns_dnssec_chain_nsec3_list
+  *  ldns_dnssec_create_nsec
+  *  ldns_dnssec_create_nsec3
+  *  ldns_dnssec_create_nsec_bitmap
+  *  ldns_dnssec_data_chain_deep_free
+  *  ldns_dnssec_data_chain_free
+  *  ldns_dnssec_data_chain_new
+  *  ldns_dnssec_data_chain_print
+  *  ldns_dnssec_default_add_to_signatures
+  *  ldns_dnssec_default_delete_signatures
+  *  ldns_dnssec_default_leave_signatures
+  *  ldns_dnssec_default_replace_signatures
+  *  ldns_dnssec_derive_trust_tree
+  *  ldns_dnssec_derive_trust_tree_dnskey_rrset
+  *  ldns_dnssec_derive_trust_tree_ds_rrset
+  *  ldns_dnssec_derive_trust_tree_no_sig
+  *  ldns_dnssec_derive_trust_tree_normal_rrset
+  *  ldns_dnssec_get_dnskey_for_rrsig
+  *  ldns_dnssec_get_rrsig_for_name_and_type
+  *  ldns_dnssec_nsec3_closest_encloser
+  *  ldns_dnssec_pkt_get_rrsigs_for_name_and_type
+  *  ldns_dnssec_pkt_get_rrsigs_for_type
+  *  ldns_dnssec_pkt_has_rrsigs
+  *  ldns_dnssec_remove_signatures
+  *  ldns_dnssec_trust_tree_add_parent
+  *  ldns_dnssec_trust_tree_contains_keys
+  *  ldns_dnssec_trust_tree_depth
+  *  ldns_dnssec_trust_tree_free
+  *  ldns_dnssec_trust_tree_new
+  *  ldns_dnssec_trust_tree_print
+  *  ldns_dnssec_verify_denial
+  *  ldns_dnssec_verify_denial_nsec3
+  *  ldns_fetch_valid_domain_keys
+  *  ldns_fget_keyword_data
+  *  ldns_fget_keyword_data_l
+  *  ldns_fget_token
+  *  ldns_fget_token_l
+  *  ldns_fskipcs
+  *  ldns_fskipcs_l
+  *  ldns_get_bit
+  *  ldns_get_bit_r
+  *  ldns_get_errorstr_by_id
+  *  ldns_get_rr_class_by_name
+  *  ldns_get_rr_list_addr_by_name
+  *  ldns_get_rr_list_hosts_frm_file
+  *  ldns_get_rr_list_hosts_frm_fp
+  *  ldns_get_rr_list_hosts_frm_fp_l
+  *  ldns_get_rr_list_name_by_addr
+  *  ldns_get_rr_type_by_name
+  *  ldns_getaddrinfo
+  *  ldns_hexdigit_to_int
+  *  ldns_hexstring_to_data
+  *  ldns_init_random
+  *  ldns_int_to_hexdigit
+  *  ldns_is_rrset
+  *  ldns_key2buffer_str
+  *  ldns_key2rr
+  *  ldns_key2str
+  *  ldns_lookup_by_id
+  *  ldns_lookup_by_name
+  *  ldns_native2rdf_int16
+  *  ldns_native2rdf_int16_data
+  *  ldns_native2rdf_int32
+  *  ldns_native2rdf_int8
+  *  ldns_nsec3_add_param_rdfs
+  *  ldns_nsec3_algorithm
+  *  ldns_nsec3_bitmap
+  *  ldns_nsec3_flags
+  *  ldns_nsec3_hash_name
+  *  ldns_nsec3_hash_name_frm_nsec3
+  *  ldns_nsec3_iterations
+  *  ldns_nsec3_next_owner
+  *  ldns_nsec3_optout
+  *  ldns_nsec3_salt
+  *  ldns_nsec3_salt_data
+  *  ldns_nsec3_salt_length
+  *  ldns_nsec_bitmap_covers_type
+  *  ldns_nsec_covers_name
+  *  ldns_nsec_get_bitmap
+  *  ldns_nsec_type_check
+  *  ldns_octet
+  *  ldns_pkt2buffer_str
+  *  ldns_pkt2buffer_wire
+  *  ldns_pkt2str
+  *  ldns_pkt2wire
+  *  ldns_pktheader2buffer_str
+  *  ldns_power
+  *  ldns_print_rr_rdf
+  *  ldns_rbtree_create
+  *  ldns_rbtree_delete
+  *  ldns_rbtree_find_less_equal
+  *  ldns_rbtree_first
+  *  ldns_rbtree_free
+  *  ldns_rbtree_init
+  *  ldns_rbtree_insert
+  *  ldns_rbtree_insert_vref
+  *  ldns_rbtree_last
+  *  ldns_rbtree_next
+  *  ldns_rbtree_previous
+  *  ldns_rbtree_search
+  *  ldns_rdf2buffer_str
+  *  ldns_rdf2buffer_str_a
+  *  ldns_rdf2buffer_str_aaaa
+  *  ldns_rdf2buffer_str_alg
+  *  ldns_rdf2buffer_str_apl
+  *  ldns_rdf2buffer_str_b64
+  *  ldns_rdf2buffer_str_cert_alg
+  *  ldns_rdf2buffer_str_class
+  *  ldns_rdf2buffer_str_dname
+  *  ldns_rdf2buffer_str_hex
+  *  ldns_rdf2buffer_str_int16
+  *  ldns_rdf2buffer_str_int16_data
+  *  ldns_rdf2buffer_str_ipseckey
+  *  ldns_rdf2buffer_str_loc
+  *  ldns_rdf2buffer_str_nsap
+  *  ldns_rdf2buffer_str_nsec
+  *  ldns_rdf2buffer_str_period
+  *  ldns_rdf2buffer_str_str
+  *  ldns_rdf2buffer_str_tsig
+  *  ldns_rdf2buffer_str_tsigtime
+  *  ldns_rdf2buffer_str_type
+  *  ldns_rdf2buffer_str_unknown
+  *  ldns_rdf2buffer_str_wks
+  *  ldns_rdf2buffer_wire
+  *  ldns_rdf2buffer_wire_canonical
+  *  ldns_rdf2native_int16
+  *  ldns_rdf2native_int32
+  *  ldns_rdf2native_int8
+  *  ldns_rdf2native_sockaddr_storage
+  *  ldns_rdf2native_time_t
+  *  ldns_rdf2rr_type
+  *  ldns_rdf2str
+  *  ldns_rdf2wire
+  *  ldns_read_anchor_file
+  *  ldns_read_uint16
+  *  ldns_read_uint32
+  *  ldns_rr2buffer_str
+  *  ldns_rr2buffer_wire
+  *  ldns_rr2buffer_wire_canonical
+  *  ldns_rr2canonical
+  *  ldns_rr2str
+  *  ldns_rr2wire
+  *  ldns_rrsig2buffer_wire
+  *  ldns_send
+  *  ldns_send_buffer
+  *  ldns_set_bit
+  *  ldns_sign_public
+  *  ldns_sockaddr_storage2rdf
+  *  ldns_str2period
+  *  ldns_str2rdf_a
+  *  ldns_str2rdf_aaaa
+  *  ldns_str2rdf_alg
+  *  ldns_str2rdf_apl
+  *  ldns_str2rdf_b32_ext
+  *  ldns_str2rdf_b64
+  *  ldns_str2rdf_cert_alg
+  *  ldns_str2rdf_class
+  *  ldns_str2rdf_dname
+  *  ldns_str2rdf_hex
+  *  ldns_str2rdf_int16
+  *  ldns_str2rdf_int32
+  *  ldns_str2rdf_int8
+  *  ldns_str2rdf_loc
+  *  ldns_str2rdf_nsap
+  *  ldns_str2rdf_nsec
+  *  ldns_str2rdf_nsec3_salt
+  *  ldns_str2rdf_period
+  *  ldns_str2rdf_service
+  *  ldns_str2rdf_str
+  *  ldns_str2rdf_time
+  *  ldns_str2rdf_tsig
+  *  ldns_str2rdf_type
+  *  ldns_str2rdf_unknown
+  *  ldns_str2rdf_wks
+  *  ldns_tcp_bgsend
+  *  ldns_tcp_connect
+  *  ldns_tcp_read_wire
+  *  ldns_tcp_send
+  *  ldns_tcp_send_query
+  *  ldns_traverse_postorder
+  *  ldns_tsig_algorithm
+  *  ldns_tsig_keydata
+  *  ldns_tsig_keydata_clone
+  *  ldns_tsig_keyname
+  *  ldns_tsig_keyname_clone
+  *  ldns_udp_bgsend
+  *  ldns_udp_connect
+  *  ldns_udp_read_wire
+  *  ldns_udp_send
+  *  ldns_udp_send_query
+  *  ldns_update_pkt_new
+  *  ldns_update_pkt_tsig_add
+  *  ldns_update_prcount
+  *  ldns_update_set_adcount
+  *  ldns_update_set_prcount
+  *  ldns_update_set_upcount
+  *  ldns_update_soa_mname
+  *  ldns_update_soa_zone_mname
+  *  ldns_update_upcount
+  *  ldns_update_zocount
+  *  ldns_validate_domain_dnskey
+  *  ldns_validate_domain_ds
+  *  ldns_verify
+  *  ldns_verify_rrsig
+  *  ldns_verify_rrsig_buffers
+  *  ldns_verify_rrsig_buffers_raw
+  *  ldns_verify_rrsig_dsa
+  *  ldns_verify_rrsig_dsa_raw
+  *  ldns_verify_rrsig_keylist
+  *  ldns_verify_rrsig_rsamd5
+  *  ldns_verify_rrsig_rsamd5_raw
+  *  ldns_verify_rrsig_rsasha1
+  *  ldns_verify_rrsig_rsasha1_raw
+  *  ldns_verify_rrsig_rsasha256_raw
+  *  ldns_verify_rrsig_rsasha512_raw
+  *  ldns_verify_trusted
+  *  ldns_version
+  *  ldns_wire2dname
+  *  ldns_wire2pkt
+  *  ldns_wire2rdf
+  *  ldns_wire2rr
+  *  ldns_write_uint16
+  *  ldns_write_uint32
+  *  ldns_write_uint64_as_uint48
+  *  mktime_from_utc
+  *  qsort_rr_compare_nsec3
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_key.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_key.rst
@@ -0,0 +1,11 @@
+Class ldns_key
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_key
+------------------------------
+.. autoclass:: ldns_key
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_key_list.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_key_list.rst
@@ -0,0 +1,11 @@
+Class ldns_key_list
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_key_list
+------------------------------
+.. autoclass:: ldns_key_list
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_pkt.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_pkt.rst
@@ -0,0 +1,11 @@
+Class ldns_pkt
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_pkt
+------------------------------
+.. autoclass:: ldns_pkt
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_rdf.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_rdf.rst
@@ -0,0 +1,47 @@
+Class ldns_rdf
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_rdf
+------------------------------
+.. autoclass:: ldns_rdf
+	:members:
+	:undoc-members:
+
+Predefined constants
+------------------------------
+
+**RDF TYPE**
+	* LDNS_RDF_TYPE_NONE,
+	* LDNS_RDF_TYPE_DNAME,
+	* LDNS_RDF_TYPE_INT8,
+	* LDNS_RDF_TYPE_INT16,
+	* LDNS_RDF_TYPE_INT32,
+	* LDNS_RDF_TYPE_A,	
+	* LDNS_RDF_TYPE_AAAA,
+	* LDNS_RDF_TYPE_STR,
+	* LDNS_RDF_TYPE_APL,
+	* LDNS_RDF_TYPE_B32_EXT,
+	* LDNS_RDF_TYPE_B64,
+	* LDNS_RDF_TYPE_HEX,
+	* LDNS_RDF_TYPE_NSEC, 
+	* LDNS_RDF_TYPE_TYPE, 
+	* LDNS_RDF_TYPE_CLASS,
+	* LDNS_RDF_TYPE_CERT_ALG,
+	* LDNS_RDF_TYPE_ALG,
+	* LDNS_RDF_TYPE_UNKNOWN,
+	* LDNS_RDF_TYPE_TIME,
+	* LDNS_RDF_TYPE_PERIOD,
+	* LDNS_RDF_TYPE_TSIGTIME,
+	* LDNS_RDF_TYPE_TSIG,
+	* LDNS_RDF_TYPE_INT16_DATA,
+	* LDNS_RDF_TYPE_SERVICE,
+	* LDNS_RDF_TYPE_LOC,
+	* LDNS_RDF_TYPE_WKS,
+	* LDNS_RDF_TYPE_NSAP,
+	* LDNS_RDF_TYPE_IPSECKEY,
+	* LDNS_RDF_TYPE_NSEC3_SALT,
+	* LDNS_RDF_TYPE_NSEC3_NEXT_OWNER
+
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_resolver.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_resolver.rst
@@ -0,0 +1,13 @@
+Class ldns_resolver
+================================
+
+..	automodule:: ldns
+
+Class ldns_resolver
+------------------------------
+.. autoclass:: ldns_resolver
+	:members:
+	:undoc-members:
+
+
+
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_rr.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_rr.rst
@@ -0,0 +1,18 @@
+Class ldns_rr
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_rr
+------------------------------
+.. autoclass:: ldns_rr
+	:members:
+	:undoc-members:
+
+Class ldns_rr_descriptor
+------------------------------
+.. autoclass:: ldns_rr_descriptor
+	:members:
+	:undoc-members:
+
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_rr_list.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_rr_list.rst
@@ -0,0 +1,11 @@
+Class ldns_rr_list
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_rr_list
+------------------------------
+.. autoclass:: ldns_rr_list
+	:members:
+	:undoc-members:
--- a/libs/ldns/contrib/python/docs/source/modules/ldns_zone.rst
+++ b/libs/ldns/contrib/python/docs/source/modules/ldns_zone.rst
@@ -0,0 +1,11 @@
+Class ldns_zone
+================================
+
+
+..	automodule:: ldns
+
+Class ldns_zone
+------------------------------
+.. autoclass:: ldns_zone
+	:members:
+	:undoc-members: