MSG_REGISTER_EVENT: ("REGISTER_EVENT", FMT_LSA_FILTER),
MSG_SYNC_LSDB: ("SYNC_LSDB", FMT_LSA_FILTER),
MSG_ORIGINATE_REQUEST: ("ORIGINATE_REQUEST", ">II" + FMT_LSA_HEADER[1:]),
- MSG_DELETE_REQUEST: ("DELETE_REQUEST", ">IBBxxL"),
+ MSG_DELETE_REQUEST: ("DELETE_REQUEST", ">IBBxBL"),
MSG_SYNC_REACHABLE: ("MSG_SYNC_REACHABLE", ""),
MSG_SYNC_ISM: ("MSG_SYNC_ISM", ""),
MSG_SYNC_NSM: ("MSG_SYNC_NSM", ""),
MSG_SYNC_ROUTER_ID: ("MSG_SYNC_ROUTER_ID", ""),
}
+# OSPF API MSG Delete Flag.
+OSPF_API_DEL_ZERO_LEN_LSA = 0x01 # send withdrawal with no LSA data
+
# --------------------------
# Messages from OSPF daemon.
# --------------------------
await self._assure_opaque_ready(lsa_type, otype)
await self.msg_send_raises(mt, msg)
- async def delete_opaque_data(self, addr, lsa_type, otype, oid):
+ async def delete_opaque_data(self, addr, lsa_type, otype, oid, flags=0):
"""Delete an instance of opaque data.
Delete an instance of opaque data. This call will register for the given
otype: (octet) opaque type. Note: the type will be registered if the user
has not explicity done that yet with `register_opaque_data`.
oid: (3 octets) ID of this opaque data
+ flags: (octet) optional flags (e.g., OSPF_API_DEL_ZERO_LEN_LSA, defaults to no flags)
Raises:
See `msg_send_raises`
"""
mt = MSG_DELETE_REQUEST
await self._assure_opaque_ready(lsa_type, otype)
- mp = struct.pack(msg_fmt[mt], int(addr), lsa_type, otype, oid)
+ mp = struct.pack(msg_fmt[mt], int(addr), lsa_type, otype, flags, oid)
await self.msg_send_raises(mt, mp)
async def register_opaque_data(self, lsa_type, otype, callback=None):
except ValueError:
addr = ip(aval)
oargs = [addr, ltype, int(_s.pop(False)), int(_s.pop(False))]
- assert len(_s) <= 1, "Bad format for action argument"
- try:
- b = bytes.fromhex(_s.pop(False))
- except IndexError:
- b = b""
- logging.info("opaque data is %s octets", len(b))
- # Needs to be multiple of 4 in length
- mod = len(b) % 4
- if mod:
- b += b"\x00" * (4 - mod)
- logging.info("opaque padding to %s octets", len(b))
-
if what.casefold() == "add":
+ try:
+ b = bytes.fromhex(_s.pop(False))
+ except IndexError:
+ b = b""
+ logging.info("opaque data is %s octets", len(b))
+ # Needs to be multiple of 4 in length
+ mod = len(b) % 4
+ if mod:
+ b += b"\x00" * (4 - mod)
+ logging.info("opaque padding to %s octets", len(b))
+
await c.add_opaque_data(*oargs, b)
else:
assert what.casefold().startswith("del")
- await c.delete_opaque_data(*oargs)
+ f = 0
+ if len(_s) >= 1:
+ try:
+ f = int(_s.pop(False))
+ except IndexError:
+ f = 0
+ await c.delete_opaque_data(*oargs, f)
if args.exit:
return 0
except Exception as error:
ap.add_argument("--server", default="localhost", help="OSPF API server")
ap.add_argument("-v", "--verbose", action="store_true", help="be verbose")
ap.add_argument(
- "actions", nargs="*", help="(ADD|DEL),LSATYPE,[ADDR,],OTYPE,OID,[HEXDATA]"
+ "actions",
+ nargs="*",
+ help="(ADD|DEL),LSATYPE,[ADDR,],OTYPE,OID,[HEXDATA|DEL_FLAG]",
)
args = ap.parse_args()
[
apibin,
"-v",
+ "add,9,10.0.1.1,230,1",
"add,9,10.0.1.1,230,2,00000202",
- "add,10,1.2.3.4,231,1,00010101",
"wait,1",
- "add,10,1.2.3.4,231,2",
- "add,11,232,3,ebadf00d",
+ "add,10,1.2.3.4,231,1",
+ "add,10,1.2.3.4,231,2,0102030405060708",
+ "wait,1",
+ "add,11,232,1",
+ "add,11,232,2,ebadf00d",
"wait,20",
- "del,10,1.2.3.4,231,1",
- "del,10,1.2.3.4,231,2",
+ "del,9,10.0.1.1,230,2,0",
+ "del,10,1.2.3.4,231,2,1",
+ "del,11,232,1,1",
]
)
-
add_input_dict = {
"areas": {
"1.2.3.4": {
"linkLocalOpaqueLsa": [
+ {
+ "lsId": "230.0.0.1",
+ "advertisedRouter": "192.168.0.1",
+ "sequenceNumber": "80000001",
+ "checksum": "6d5f",
+ },
{
"lsId": "230.0.0.2",
"advertisedRouter": "192.168.0.1",
"sequenceNumber": "80000001",
"checksum": "8142",
- }
+ },
],
+ "linkLocalOpaqueLsaCount": 2,
"areaLocalOpaqueLsa": [
{
"lsId": "231.0.0.1",
"advertisedRouter": "192.168.0.1",
"sequenceNumber": "80000001",
- "checksum": "695a",
+ "checksum": "5278",
},
{
"lsId": "231.0.0.2",
"advertisedRouter": "192.168.0.1",
"sequenceNumber": "80000001",
- "checksum": "4881",
+ "checksum": "6d30",
},
],
- }
+ "areaLocalOpaqueLsaCount": 2,
+ },
},
"asExternalOpaqueLsa": [
{
- "lsId": "232.0.0.3",
+ "lsId": "232.0.0.1",
"advertisedRouter": "192.168.0.1",
"sequenceNumber": "80000001",
- "checksum": "c666",
- }
+ "checksum": "5575",
+ },
+ {
+ "lsId": "232.0.0.2",
+ "advertisedRouter": "192.168.0.1",
+ "sequenceNumber": "80000001",
+ "checksum": "d05d",
+ },
],
+ "asExternalOpaqueLsaCount": 2,
}
step("reachable: check for add LSAs")
"linkLocalOpaqueLsa": {
"areas": {
"1.2.3.4": [
+ {
+ "linkStateId": "230.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "6d5f",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
{
"linkStateId": "230.0.0.2",
"advertisingRouter": "192.168.0.1",
"length": 24,
"opaqueId": 2,
"opaqueDataLength": 4,
- }
+ },
]
}
}
"linkStateId": "231.0.0.1",
"advertisingRouter": "192.168.0.1",
"lsaSeqNumber": "80000001",
- "checksum": "695a",
- "length": 24,
- "opaqueDataLength": 4,
+ "checksum": "5278",
+ "length": 20,
+ "opaqueDataLength": 0,
},
{
"linkStateId": "231.0.0.2",
"advertisingRouter": "192.168.0.1",
"lsaSeqNumber": "80000001",
- "checksum": "4881",
- "length": 20,
- "opaqueDataLength": 0,
+ "checksum": "6d30",
+ "length": 28,
+ "opaqueDataLength": 8,
},
- ]
- }
- }
+ ],
+ },
+ },
},
{
"asExternalOpaqueLsa": [
{
- "linkStateId": "232.0.0.3",
+ "linkStateId": "232.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "5575",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "linkStateId": "232.0.0.2",
"advertisingRouter": "192.168.0.1",
"lsaSeqNumber": "80000001",
- "checksum": "c666",
+ "checksum": "d05d",
"length": 24,
"opaqueDataLength": 4,
- }
- ]
+ },
+ ],
},
]
i = 0
# Wait for add notification
# RECV: LSA update msg for LSA 232.0.0.3 in area 0.0.0.0 seq 0x80000001 len 24 age 9
- step("reachable: check for API add notifications")
- ls_ids = ["230.0.0.2", "231.0.0.1", "231.0.0.2", "232.0.0.3"]
+ ls_ids = [
+ "230.0.0.1",
+ "230.0.0.2",
+ "231.0.0.1",
+ "231.0.0.2",
+ "232.0.0.1",
+ "232.0.0.2",
+ ]
for ls_id in ls_ids:
+ step("reachable: check for API add notification: %s" % ls_id)
waitfor = "RECV:.*update msg.*LSA {}.*age ([0-9]+)".format(ls_id)
_ = _wait_output(pread, waitfor)
"areas": {
"1.2.3.4": {
"linkLocalOpaqueLsa": [
+ {
+ "lsId": "230.0.0.1",
+ "advertisedRouter": "192.168.0.1",
+ "sequenceNumber": "80000001",
+ "checksum": "6d5f",
+ },
{
"lsId": "230.0.0.2",
"advertisedRouter": "192.168.0.1",
+ "lsaAge": 3600,
"sequenceNumber": "80000001",
"checksum": "8142",
- }
+ },
],
+ "linkLocalOpaqueLsaCount": 2,
"areaLocalOpaqueLsa": [
{
- "lsaAge": 3600,
"lsId": "231.0.0.1",
"advertisedRouter": "192.168.0.1",
"sequenceNumber": "80000001",
- "checksum": "695a",
+ "checksum": "5278",
},
{
- "lsaAge": 3600,
"lsId": "231.0.0.2",
"advertisedRouter": "192.168.0.1",
- "sequenceNumber": "80000001",
- "checksum": "4881",
+ "lsaAge": 3600,
+ "sequenceNumber": "80000002",
+ "checksum": "4682",
},
],
- }
+ "areaLocalOpaqueLsaCount": 2,
+ },
},
"asExternalOpaqueLsa": [
{
- "lsId": "232.0.0.3",
+ "lsId": "232.0.0.1",
"advertisedRouter": "192.168.0.1",
+ "lsaAge": 3600,
"sequenceNumber": "80000001",
- "checksum": "c666",
- }
+ "checksum": "5575",
+ },
+ {
+ "lsId": "232.0.0.2",
+ "advertisedRouter": "192.168.0.1",
+ "sequenceNumber": "80000001",
+ "checksum": "d05d",
+ },
],
+ "asExternalOpaqueLsaCount": 2,
}
step("reachable: check for explicit withdrawal LSAs")
assert verify_ospf_database(tgen, r1, del_input_dict, json_cmd) is None
assert verify_ospf_database(tgen, r2, del_input_dict, json_cmd) is None
+ del_detail_input_dict = [
+ {
+ "linkLocalOpaqueLsa": {
+ "areas": {
+ "1.2.3.4": [
+ {
+ "linkStateId": "230.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "6d5f",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "linkStateId": "230.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "8142",
+ "length": 24,
+ "opaqueId": 2,
+ "opaqueDataLength": 4,
+ },
+ ]
+ }
+ }
+ },
+ {
+ "areaLocalOpaqueLsa": {
+ "areas": {
+ "1.2.3.4": [
+ {
+ "linkStateId": "231.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "5278",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "lsaAge": 3600,
+ "linkStateId": "231.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000002",
+ "checksum": "4682",
+ # data removed
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ ],
+ },
+ },
+ },
+ {
+ "asExternalOpaqueLsa": [
+ {
+ "linkStateId": "232.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "5575",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "linkStateId": "232.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "d05d",
+ "length": 24,
+ "opaqueDataLength": 4,
+ },
+ ],
+ },
+ ]
+ i = 0
+ while i < numcs:
+ step("reachable: check for delete LSA details: %s" % json_cmds[i])
+ assert (
+ verify_ospf_database(tgen, r1, del_detail_input_dict[i], json_cmds[i])
+ is None
+ )
+ assert (
+ verify_ospf_database(tgen, r2, del_detail_input_dict[i], json_cmds[i])
+ is None
+ )
+ i += 1
+
p.terminate()
if p.wait():
comm_error(p)
- del_input_dict = {
- "areas": {
- "1.2.3.4": {
- "linkLocalOpaqueLsa": [
- {
- "lsaAge": 3600,
- "lsId": "230.0.0.2",
- "advertisedRouter": "192.168.0.1",
- "sequenceNumber": "80000001",
- "checksum": "8142",
- }
- ],
- "areaLocalOpaqueLsa": [
- {
- "lsaAge": 3600,
- "lsId": "231.0.0.1",
- "advertisedRouter": "192.168.0.1",
- "sequenceNumber": "80000001",
- "checksum": "695a",
- },
- {
- "lsaAge": 3600,
- "lsId": "231.0.0.2",
- "advertisedRouter": "192.168.0.1",
- "sequenceNumber": "80000001",
- "checksum": "4881",
- },
- ],
+
+ del_detail_input_dict = [
+ {
+ "linkLocalOpaqueLsa": {
+ "areas": {
+ "1.2.3.4": [
+ {
+ "linkStateId": "230.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "6d5f",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "linkStateId": "230.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "8142",
+ "length": 24,
+ "opaqueId": 2,
+ "opaqueDataLength": 4,
+ },
+ ]
+ }
}
},
- "asExternalOpaqueLsa": [
- {
- "lsaAge": 3600,
- "lsId": "232.0.0.3",
- "advertisedRouter": "192.168.0.1",
- "sequenceNumber": "80000001",
- "checksum": "c666",
- }
- ],
- }
-
- step("reachable: check for implicit withdrawal LSAs")
- json_cmd = "show ip ospf da json"
- assert verify_ospf_database(tgen, r1, del_input_dict, json_cmd) is None
- assert verify_ospf_database(tgen, r2, del_input_dict, json_cmd) is None
+ {
+ "areaLocalOpaqueLsa": {
+ "areas": {
+ "1.2.3.4": [
+ {
+ "lsaAge": 3600,
+ "linkStateId": "231.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000001",
+ "checksum": "5278",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "lsaAge": 3600,
+ "linkStateId": "231.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaSeqNumber": "80000002",
+ "checksum": "4682",
+ # data removed
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ ],
+ },
+ },
+ },
+ {
+ "asExternalOpaqueLsa": [
+ {
+ "linkStateId": "232.0.0.1",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "5575",
+ "length": 20,
+ "opaqueDataLength": 0,
+ },
+ {
+ "linkStateId": "232.0.0.2",
+ "advertisingRouter": "192.168.0.1",
+ "lsaAge": 3600,
+ "lsaSeqNumber": "80000001",
+ "checksum": "d05d",
+ "length": 24,
+ "opaqueDataLength": 4,
+ },
+ ],
+ },
+ ]
+ i = 0
+ while i < numcs:
+ step(
+ "reachable: check for post API shutdown delete LSA details: %s"
+ % json_cmds[i]
+ )
+ assert (
+ verify_ospf_database(tgen, r1, del_detail_input_dict[i], json_cmds[i])
+ is None
+ )
+ assert (
+ verify_ospf_database(tgen, r2, del_detail_input_dict[i], json_cmds[i])
+ is None
+ )
+ i += 1
# step("reachable: check for flush/age out")
# # Wait for max age notification
# waitfor = "RECV:.*update msg.*LSA {}.*age 3600".format(ls_id)
# _wait_output(pread, waitfor)
-
- step("reachable: check for API delete notifications")
- ls_ids = ["231.0.0.1", "231.0.0.2", "230.0.0.2", "232.0.0.3"]
+ ls_ids = [
+ "230.0.0.2",
+ "231.0.0.2",
+ "232.0.0.1",
+ "230.0.0.1",
+ "231.0.0.1",
+ "232.0.0.2",
+ ]
for ls_id in ls_ids:
- waitfor = "RECV:.*delete msg.*LSA {}.*".format(ls_id)
+ step("reachable: check for API delete notification: %s" % ls_id)
+ waitfor = "RECV:.*delete msg.*LSA {}.*age".format(ls_id)
_ = _wait_output(pread, waitfor)
except Exception:
if p: