Rename offline to offline_only

Author: the-soloist

pwnlib/libcdb.py

@@ -148,7 +148,7 @@ def provider_local_database(hex_encoded_id, hash_type):
     "online": [provider_libcdb, provider_libc_rip]
 }
 
-def search_by_hash(hex_encoded_id, hash_type='build_id', unstrip=True, offline=False):
+def search_by_hash(hex_encoded_id, hash_type='build_id', unstrip=True, offline_only=False):
     assert hash_type in HASHES, hash_type
 
     # Ensure that the libcdb cache directory exists
@@ -161,7 +161,7 @@ def search_by_hash(hex_encoded_id, hash_type='build_id', unstrip=True, offline=F
         return None
 
     providers = PROVIDERS["offline"]
-    if not offline:
+    if not offline_only:
         providers += PROVIDERS["online"]
 
     # Run through all available libc database providers to see if we have a match.
@@ -610,7 +610,7 @@ def search_by_symbol_offsets(symbols, select_index=None, unstrip=True, return_as
     selected_libc = _handle_multiple_matching_libcs(matching_libcs)
     return search_by_build_id(selected_libc['buildid'], unstrip=unstrip)
 
-def search_by_build_id(hex_encoded_id, unstrip=True, offline=False):
+def search_by_build_id(hex_encoded_id, unstrip=True, offline_only=False):
     """
     Given a hex-encoded Build ID, attempt to download a matching libc from libcdb.
 
@@ -619,8 +619,10 @@ def search_by_build_id(hex_encoded_id, unstrip=True, offline=False):
             Hex-encoded Build ID (e.g. 'ABCDEF...') of the library
         unstrip(bool):
             Try to fetch debug info for the libc and apply it to the downloaded file.
-        offline(bool):
-            Enable offline search mode, which will disable online providers.
+        offline_only(bool):
+            Both offline and online providers are used by default. When pass
+            `offline_only=True`, libcdb enable an exclusive offline search mode,
+            which will disable online providers.
 
     Returns:
         Path to the downloaded library on disk, or :const:`None`.
@@ -636,9 +638,9 @@ def search_by_build_id(hex_encoded_id, unstrip=True, offline=False):
         >>> hex(ELF(filename).symbols.read)
         '0xeef40'
     """
-    return search_by_hash(hex_encoded_id, 'build_id', unstrip, offline)
+    return search_by_hash(hex_encoded_id, 'build_id', unstrip, offline_only)
 
-def search_by_md5(hex_encoded_id, unstrip=True, offline=False):
+def search_by_md5(hex_encoded_id, unstrip=True, offline_only=False):
     """
     Given a hex-encoded md5sum, attempt to download a matching libc from libcdb.
 
@@ -647,8 +649,10 @@ def search_by_md5(hex_encoded_id, unstrip=True, offline=False):
             Hex-encoded md5sum (e.g. 'ABCDEF...') of the library
         unstrip(bool):
             Try to fetch debug info for the libc and apply it to the downloaded file.
-        offline(bool):
-            Enable offline search mode, which will disable online providers.
+        offline_only(bool):
+            Both offline and online providers are used by default. When pass
+            `offline_only=True`, libcdb enable an exclusive offline search mode,
+            which will disable online providers.
 
     Returns:
         Path to the downloaded library on disk, or :const:`None`.
@@ -664,9 +668,9 @@ def search_by_md5(hex_encoded_id, unstrip=True, offline=False):
         >>> hex(ELF(filename).symbols.read)
         '0xeef40'
     """
-    return search_by_hash(hex_encoded_id, 'md5', unstrip, offline)
+    return search_by_hash(hex_encoded_id, 'md5', unstrip, offline_only)
 
-def search_by_sha1(hex_encoded_id, unstrip=True, offline=False):
+def search_by_sha1(hex_encoded_id, unstrip=True, offline_only=False):
     """
     Given a hex-encoded sha1, attempt to download a matching libc from libcdb.
 
@@ -675,8 +679,10 @@ def search_by_sha1(hex_encoded_id, unstrip=True, offline=False):
             Hex-encoded sha1sum (e.g. 'ABCDEF...') of the library
         unstrip(bool):
             Try to fetch debug info for the libc and apply it to the downloaded file.
-        offline(bool):
-            Enable offline search mode, which will disable online providers.
+        offline_only(bool):
+            Both offline and online providers are used by default. When pass
+            `offline_only=True`, libcdb enable an exclusive offline search mode,
+            which will disable online providers.
 
     Returns:
         Path to the downloaded library on disk, or :const:`None`.
@@ -692,10 +698,9 @@ def search_by_sha1(hex_encoded_id, unstrip=True, offline=False):
         >>> hex(ELF(filename).symbols.read)
         '0xeef40'
     """
-    return search_by_hash(hex_encoded_id, 'sha1', unstrip, offline)
+    return search_by_hash(hex_encoded_id, 'sha1', unstrip, offline_only)
 
-
-def search_by_sha256(hex_encoded_id, unstrip=True, offline=False):
+def search_by_sha256(hex_encoded_id, unstrip=True, offline_only=False):
     """
     Given a hex-encoded sha256, attempt to download a matching libc from libcdb.
 
@@ -704,8 +709,10 @@ def search_by_sha256(hex_encoded_id, unstrip=True, offline=False):
             Hex-encoded sha256sum (e.g. 'ABCDEF...') of the library
         unstrip(bool):
             Try to fetch debug info for the libc and apply it to the downloaded file.
-        offline(bool):
-            Enable offline search mode, which will disable online providers.
+        offline_only(bool):
+            Both offline and online providers are used by default. When pass
+            `offline_only=True`, libcdb enable an exclusive offline search mode,
+            which will disable online providers.
 
     Returns:
         Path to the downloaded library on disk, or :const:`None`.
@@ -721,7 +728,7 @@ def search_by_sha256(hex_encoded_id, unstrip=True, offline=False):
         >>> hex(ELF(filename).symbols.read)
         '0xeef40'
     """
-    return search_by_hash(hex_encoded_id, 'sha256', unstrip, offline)
+    return search_by_hash(hex_encoded_id, 'sha256', unstrip, offline_only)