VB.NET IP Manipulation Utility Functions

Seekers,

Here are some VB.NET functions I’ve written & collected that form a tidy utility class I use often in my work with IP v6 & v4 addresses. They are not complete, as I need to write a few more for v6 stuff than I have already. One thing I’m still looking for is a good way to represent v6 addresses for a variety of calculations…

From the Interface:

Interface IIPUtils
        '
Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String
Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String
Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress
Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal
Function DecimalToByteArray(dec As Decimal) As Byte()
Function ByteArrayToString(byteArray As Byte()) As String
Function CompressIpToString_v46(ipAddr As String) As String
Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress
Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String
Function GetByteArrayFromString(aString As String) As Byte()
Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String
Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long
Function IpAddrStringToByteArray(theIpString As String) As Byte()
Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long
Function IpLongToIpString(ByVal theIP As Long) As String
Function StringToBytesAsString(someAddress As String) As String
Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean
Function HostToIP_v4(ByVal hostName As String) As String
Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String
Function Int64ToIp_v4(ByVal ipAddress As Int64) As String
Function IpToInt64_v4(ByVal ipAddress As String) As Int64
Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress
Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean
'
Sub PrintExceptions(ex As Exception)
'
End Interface

Interface IIPUtils

Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String

Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String

Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress

Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal

Function DecimalToByteArray(dec As Decimal) As Byte()

Function ByteArrayToString(byteArray As Byte()) As String

Function CompressIpToString_v46(ipAddr As String) As String

Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress

Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String

Function GetByteArrayFromString(aString As String) As Byte()

Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String

Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long

Function IpAddrStringToByteArray(theIpString As String) As Byte()

Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long

Function IpLongToIpString(ByVal theIP As Long) As String

Function StringToBytesAsString(someAddress As String) As String

Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean

Function HostToIP_v4(ByVal hostName As String) As String

Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String

Function Int64ToIp_v4(ByVal ipAddress As Int64) As String

Function IpToInt64_v4(ByVal ipAddress As String) As Int64

Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress

Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean

Sub PrintExceptions(ex As Exception)

End Interface

Continued…

…and the full class:

Imports System.IO
Imports System.Net
Imports System.Net.Sockets
Imports System.Text
Imports System.Text.RegularExpressions
Imports Microsoft.VisualBasic.FileIO
' 3rd party
Imports KellermanSoftware.NetLoggingLibrary

Namespace toag.utils
    Interface IIPUtils
        '
        Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String
        Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String
        Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress
        Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal
        Function DecimalToByteArray(dec As Decimal) As Byte()
        Function ByteArrayToString(byteArray As Byte()) As String
        Function CompressIpToString_v46(ipAddr As String) As String
        Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress
        Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String
        Function GetByteArrayFromString(aString As String) As Byte()
        Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String
        Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long
        Function IpAddrStringToByteArray(theIpString As String) As Byte()
        Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long
        Function IpLongToIpString(ByVal theIP As Long) As String
        Function StringToBytesAsString(someAddress As String) As String
        Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean
        Function HostToIP_v4(ByVal hostName As String) As String
        Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String
        Function Int64ToIp_v4(ByVal ipAddress As Int64) As String
        Function IpToInt64_v4(ByVal ipAddress As String) As Int64
        Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress
        Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean
        '
        Sub PrintExceptions(ex As Exception)
        '
    End Interface
    Public Class IPUtils
        Implements IIPUtils
        '
#Region "Functions"
        Public Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String Implements IIPUtils.GetCIDRNetworkFromStartAndStopIpAddresses_v4
            Dim cidr As StringBuilder = New StringBuilder
            Dim startAddr As Long = Nothing
            Dim endAddr As Long = Nothing
            Try
                ' startAddr = &HC0A80001L ' 192.168.0.1
                ' endAddr = &HC0A800FEL ' 192.168.0.254
                startAddr = Me.IpAddrToLong(IPAddress.Parse(StartIP))
                endAddr = Me.IpAddrToLong(IPAddress.Parse(StopIP))
                ' Determine all bits that are different between the two IPs
                Dim diffs = startAddr Xor endAddr
                ' Now count the number of consecutive zero bits starting at the most significant
                Dim bits = 32
                Dim mask = 0
                Do While diffs <> 0
                    ' We keep shifting diffs right until it's zero (i.e. we've shifted all the non-zero bits off)
                    diffs >>= 1
                    ' Every time we shift, that's one fewer consecutive zero bits in the prefix
                    bits -= 1
                    ' Accumulate a mask which will have zeros in the consecutive zeros of the prefix and ones elsewhere
                    mask = (mask << 1) Or 1
                Loop
                ' Construct the root of the range by inverting the mask and ANDing it with the start address
                Dim root = startAddr And Not mask
                ' Finally, output the range
                ' Console.WriteLine("{0}.{1}.{2}.{3}/{4}", root >> 24, (root >> 16) And &HFF, (root >> 8) And &HFF, root And &HFF, bits)
                cidr.Append((root >> 24) & ".")
                cidr.Append(((root >> 16) And &HFF) & ".")
                cidr.Append(((root >> 8) And &HFF) & ".")
                cidr.Append((root And &HFF) & "/")
                cidr.Append(bits)
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return cidr.ToString
        End Function
        Public Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String Implements IIPUtils.GetCIDRNotationFromIpAndNetmask
            Dim answer As String = Nothing
            Try
                Dim theIP As Net.IPAddress = Net.IPAddress.Parse(ipAddress)
                Dim theMASK As Net.IPAddress = Net.IPAddress.Parse(netMask)
                Dim ipL As Long = IpAddrToLong(theIP)
                Dim maskL As Long = IpAddrToLong(theMASK)
                'Convert  Mask to CIDR(1-30)
                Dim oneBit As Long = &H80000000L
                Dim CIDR As Integer = 0
                For x As Integer = 31 To 0 Step -1
                    If (maskL And oneBit) = oneBit Then CIDR += 1 Else Exit For
                    oneBit = oneBit >> 1
                Next
                answer = Me.IpLongToIpString(ipL And maskL) & "/" & CIDR.ToString
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return answer
        End Function
        Public Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress Implements IIPUtils.GetLastIpAddress_v4
            ' example usage:
            '
            '   Dim ipStartAddress As String = "1.2.3.0"
            '   Dim ipAddressesToAdd As Integer = "4096"
            '   Console.WriteLine("--------------------")
            '   Console.WriteLine("last ip: " & iu.GetLastAddress(ipStartAddress, ipAddressesToAdd).ToString)
            '   Console.WriteLine("--------------------")
            '
            ' output:
            '
            '   --------------------
            '   last ip: 1.2.19.0
            '   --------------------
            ' 
            ' NOTE: for RIRs, we need to subtract 1 from end address... otherwise last address = first address of next range.
            '   easiest way to do this is to subtract 1 from the # of addresses:
            NumberOfAddresses -= 1
            '
            Dim ipLast As IPAddress = Nothing
            Try
                ipLast = IPAddress.Parse(Me.IpLongToIpString(Me.IpAddrToLong(IPAddress.Parse(StartAddress)) + CLng(NumberOfAddresses)))
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return ipLast
        End Function
        Public Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal Implements IIPUtils.ByteArrayToDecimal
            'check that it is even possible to convert the array 
            If bytes.Count() <> 16 Then
                Throw New Exception("A decimal must be created from exactly 16 bytes")
            End If
            'make an array to convert back to int32's 
            Dim bits(3) As Int32
            For i As Integer = 0 To 15 Step 4
                'convert every 4 bytes into an int32 
                bits(i \ 4) = BitConverter.ToInt32(bytes, i)
            Next i
            'Use the decimal's new constructor to 
            'create an instance of decimal 
            Return New Decimal(bits)
        End Function
        Public Function DecimalToByteArray(dec As Decimal) As Byte() Implements IIPUtils.DecimalToByteArray
            'Load four 32 bit integers from the Decimal.GetBits function 
            Dim bits As Int32() = Decimal.GetBits(dec)
            'Create a temporary list to hold the bytes 
            Dim bytes As New List(Of Byte)
            'iterate each 32 bit integer 
            For Each i As Int32 In bits
                'add the bytes of the current 32bit integer to the bytes list 
                bytes.AddRange(BitConverter.GetBytes(i))
            Next
            'return the bytes list as an array 
            Return bytes.ToArray
        End Function
        Public Function ByteArrayToString(byteArray As Byte()) As String Implements IIPUtils.ByteArrayToString
            Dim r As StringBuilder = New StringBuilder()
            Try
                For Each b As Byte In byteArray
                    Console.WriteLine("{0} = {1}", b, ChrW(b))
                Next
            Catch ex As FormatException
                Log.Fatal("FormatException caught:")
                Log.Fatal("Source: " & ex.Source)
                Log.Fatal("Message: " & ex.Message)
                Log.Fatal("Stack: " & ex.StackTrace)
            Catch ex As Exception
                Log.Fatal("Exception caught")
                Log.Fatal("Source: " & ex.Source)
                Log.Fatal("Message: " & ex.Message)
                Log.Fatal("Stack: " & ex.StackTrace)
            End Try
            Return r.ToString
        End Function
        Public Function CompressIpToString_v46(ipAddr As String) As String Implements IIPUtils.CompressIpToString_v46
            Dim address As IPAddress = Nothing
            Try
                ' Create an instance of IPAddress for the specified address string (in  
                ' dotted-quad, or colon-hexadecimal notation). 
                address = IPAddress.Parse(ipAddr)
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return address.ToString
        End Function 'parse
        Public Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress Implements IIPUtils.CompressIpStringToIPaddress_v46
            Dim address As IPAddress = Nothing
            Try
                ' Create an instance of IPAddress for the specified address string (in  
                ' dotted-quad, or colon-hexadecimal notation). 
                address = IPAddress.Parse(ipAddr)
            Catch e As Exception
                PrintExceptions(e)
            End Try
            Return address
        End Function 'parse
        Public Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String Implements IIPUtils.ExpandShortIpStringToString_v46
            Dim uncompressed As String = ""
            Try
                Dim addr As IPAddress = IPAddress.Parse(shortIpAddress)
                If addr.AddressFamily = AddressFamily.InterNetworkV6 Then ' v6
                    Dim bytes() As Byte = addr.GetAddressBytes()
                    System.Diagnostics.Debug.Assert(bytes.Length = 16, "bytes.Length == 16")
                    Dim bldr As New System.Text.StringBuilder()
                    For i As Integer = 0 To 15 Step 2
                        bldr.AppendFormat("{0:x2}{1:x2}:", bytes(i), bytes(i + 1))
                    Next i
                    bldr.Length = bldr.Length - 1 'last colon
                    uncompressed = bldr.ToString()
                Else ' v4
                    uncompressed = shortIpAddress
                End If
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return uncompressed
        End Function
        Public Function GetByteArrayFromString(aString As String) As Byte() Implements IIPUtils.GetByteArrayFromString
            Dim baResult() As Byte = {}
            Try
                ' XXX shouldn't I be taking the "." out for v4?
                baResult = System.Text.Encoding.ASCII.GetBytes(aString)
            Catch ex As FormatException
                Log.Fatal("GetByteArrayFromString(" & aString & ") FormatException caught!!!")
                Log.Fatal("GetByteArrayFromString(" & aString & ") Message : " + ex.Message)
                Log.Fatal("GetByteArrayFromString(" & aString & ") ToString : " + ex.ToString)
                Log.Fatal("GetByteArrayFromString(" & aString & ") Source : " + ex.Source)
            Catch ex As Exception
                Log.Fatal("GetByteArrayFromString(" & aString & ") Exception caught!!!")
                Log.Fatal("GetByteArrayFromString(" & aString & ") Message : " + ex.Message)
                Log.Fatal("GetByteArrayFromString(" & aString & ") ToString : " + ex.ToString)
                Log.Fatal("GetByteArrayFromString(" & aString & ") Source : " + ex.Source)
            End Try
            Return baResult
        End Function
        Public Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String Implements IIPUtils.IpStringAndMaskToCidrAsString_v4
            Dim sCidr As String = ""
            Try
                Dim someIP As Net.IPAddress = Net.IPAddress.Parse(ipAddress)
                Dim someMASK As Net.IPAddress = Net.IPAddress.Parse(ipNetmask)
                Dim ipL As Long = Me.IpAddrToLong(someIP)
                Dim maskL As Long = IpAddrToLong(someMASK)
                'Convert  Mask to CIDR(1-30)
                Dim oneBit As Long = &H80000000L
                Dim CIDR As Integer = 0
                For x As Integer = 31 To 0 Step -1
                    If (maskL And oneBit) = oneBit Then CIDR += 1 Else Exit For
                    oneBit = oneBit >> 1
                Next
                sCidr = Me.IpLongToIpString(ipL And maskL) & " /" & CIDR.ToString
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return sCidr
        End Function
        Public Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long Implements IIPUtils.IpAddrToLong 'convert IP to number
            Dim addr As Long 'accumulator for address
            Try
                Dim IPb() As Byte = theIP.GetAddressBytes 'get the octets
                For x As Integer = 0 To 3
                    addr = addr Or (CLng(IPb(x)) << (3 - x) * 8)
                Next
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return addr
        End Function
        Public Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long Implements IIPUtils.MaskLongFromCidrInt
            MaskLongFromCidrInt = CLng(2 ^ ((32 - CIDR)) - 1) Xor 4294967295L
        End Function
        Public Function IpLongToIpString(ByVal theIP As Long) As String Implements IIPUtils.IpLongToIpString ' convert number back to IP
            Dim IPb(3) As Byte '4 octets
            Dim addr As String = "" 'accumulator for address
            Dim mask8 As Long = Me.MaskLongFromCidrInt(8) 'create eight bit mask
            For x = 0 To 3 'get the octets
                IPb(x) = CByte((theIP And mask8) >> ((3 - x) * 8))
                mask8 = mask8 >> 8
                addr &= IPb(x).ToString & "." 'add current octet to string
            Next
            Return addr.TrimEnd("."c)
        End Function
        Public Function StringToBytesAsString(someAddress As String) As String Implements IIPUtils.StringToBytesAsString
            Dim sbResult As StringBuilder = New StringBuilder
            Try
                Dim theBytes As [Byte]() = Me.GetByteArrayFromString(someAddress)
                Dim i As Integer
                For i = 0 To theBytes.Length - 1
                    sbResult.Append(theBytes(i))
                Next i
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return sbResult.ToString
        End Function
        Public Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean Implements IIPUtils.IsIpAddress_v4
            If New System.Text.RegularExpressions.Regex("^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$").Match(ipAddress).Success = False Then Return False
            Return System.Net.IPAddress.TryParse(ipAddress, Nothing)
        End Function
        Public Function IpToInt64_v4(ByVal ipAddress As String) As Int64 Implements IIPUtils.IpToInt64_v4
            Dim ipBytes = ipAddress.Split(".")
            Return (ipBytes(0) << 24) Or (ipBytes(1) << 16) Or (ipBytes(2) << 8) Or (ipBytes(3))
        End Function
        Public Function Int64ToIp_v4(ByVal ipAddress As Int64) As String Implements IIPUtils.Int64ToIp_v4
            Return System.Net.IPAddress.Parse(ipAddress.ToString).ToString
        End Function
        Public Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String Implements IIPUtils.IpToScope_v4
            Return Int64ToIp_v4(IpToInt64_v4(ipAddress) And IpToInt64_v4(subnetMask))
        End Function
        Public Function HostToIP_v4(ByVal hostName As String) As String Implements IIPUtils.HostToIP_v4
            Try
                Return System.Net.Dns.GetHostAddresses(hostName)(0).ToString()
            Catch ex As Exception
                Return ""
            End Try
        End Function
        Public Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress Implements IIPUtils.IpAsStringToNetIpAddress
            Return IPAddress.Parse(theIpAddress)
        End Function
        Public Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean Implements IIPUtils.IsAddressStringBetweenIpStrings
            Dim result As Boolean = False
            Try
                Dim rangeStart As Net.IPAddress = Net.IPAddress.Parse(firstIp)
                Dim rangeEnd As Net.IPAddress = Net.IPAddress.Parse(lastIp)
                Dim check As Net.IPAddress = Net.IPAddress.Parse(theIp)
                'get the bytes of the address
                Dim rbs() As Byte = rangeStart.GetAddressBytes
                Dim rbe() As Byte = rangeEnd.GetAddressBytes
                Dim cb() As Byte = check.GetAddressBytes
                'reverse them for conversion
                Array.Reverse(rbs)
                Array.Reverse(rbe)
                Array.Reverse(cb)
                'convert them
                Dim rs As UInt32 = BitConverter.ToUInt32(rbs, 0)
                Dim re As UInt32 = BitConverter.ToUInt32(rbe, 0)
                Dim chk As UInt32 = BitConverter.ToUInt32(cb, 0)
                'check
                If chk >= rs AndAlso chk <= re Then
                    result = True
                End If
            Catch ex As Exception
                Me.PrintExceptions(ex)
            End Try
            Return result
        End Function
        Function IpAddrStringToByteArray(theIpString As String) As Byte() Implements IIPUtils.IpAddrStringToByteArray
            Dim result As Byte() = Nothing
            Try
                result = Me.IpAsStringToNetIpAddress(theIpString).GetAddressBytes()
            Catch ex As Exception
                PrintExceptions(ex)
            End Try
            Return result
        End Function
#End Region
#Region "Subs"
        Private Sub PrintExceptions(ex As Exception) Implements IIPUtils.PrintExceptions
            Try
                Dim exType As Type = ex.GetType
                Log.Debug("-----start-----")
                Log.Debug("Exception caught: " & exType.ToString)
                If exType.ToString = "System.FormatException" Then
                    Log.Debug("FormatException caught:")
                ElseIf exType.ToString = "System.ArgumentNullException" Then
                    Log.Error("ArgumentNullException caught:")
                Else
                    Log.Error("Generic Exception caught:")
                End If
                Log.Debug("Source: " & ex.Source)
                Log.Debug("Message: " & ex.Message)
                Log.Debug("ToString: " & ex.ToString)
                Log.Debug("Stack: " & ex.StackTrace)
                Log.Debug("-----end-----")
            Catch methodEx As Exception
                Log.Fatal("methodEx.msg: " & methodEx.Message)
                Log.Fatal("methodEx.tos: " & methodEx.ToString)
                Log.Fatal("methodEx.stk: " & methodEx.StackTrace)
            End Try
        End Sub
        Private Sub CursorWait()
            Me.MW.Dispatcher.BeginInvoke(CType(Sub() Mouse.OverrideCursor = System.Windows.Input.Cursors.Wait, Action))
        End Sub
        Private Sub CursorArrow()
            Me.MW.Dispatcher.BeginInvoke(CType(Sub() Mouse.OverrideCursor = System.Windows.Input.Cursors.Arrow, Action))
        End Sub
        Private Sub UpdateStatusLeft(UpdateText As String)
            Try
                If UpdateText.Length > 0 Then
                    Me.MW.Dispatcher.BeginInvoke(CType(Sub() Me.MW.StatusLeft.Text = UpdateText, Action))
                End If
            Catch ex As StackOverflowException
                Log.Fatal("[UpdateStatusLeft()] StackOverflow (Message): ", ex.Message())
                Log.Fatal("[UpdateStatusLeft()] StackOverflow (ToString): ", ex.ToString())
                Log.Fatal("[UpdateStatusLeft()] StackOverflow (StackTrace): ", ex.StackTrace())
            Catch ex As Exception
                Log.Fatal("[UpdateStatusLeft()] Failed (Message): ", ex.Message())
                Log.Fatal("[UpdateStatusLeft()] Failed (ToString): ", ex.ToString())
                Log.Fatal("[UpdateStatusLeft()] Failed (StackTrace): ", ex.StackTrace())
            End Try
        End Sub
#End Region
    End Class
End Namespace

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

Imports System.IO

Imports System.Net

Imports System.Net.Sockets

Imports System.Text

Imports System.Text.RegularExpressions

Imports Microsoft.VisualBasic.FileIO

' 3rd party

Imports KellermanSoftware.NetLoggingLibrary

Namespace toag.utils

Interface IIPUtils

Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String

Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String

Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress

Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal

Function DecimalToByteArray(dec As Decimal) As Byte()

Function ByteArrayToString(byteArray As Byte()) As String

Function CompressIpToString_v46(ipAddr As String) As String

Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress

Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String

Function GetByteArrayFromString(aString As String) As Byte()

Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String

Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long

Function IpAddrStringToByteArray(theIpString As String) As Byte()

Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long

Function IpLongToIpString(ByVal theIP As Long) As String

Function StringToBytesAsString(someAddress As String) As String

Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean

Function HostToIP_v4(ByVal hostName As String) As String

Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String

Function Int64ToIp_v4(ByVal ipAddress As Int64) As String

Function IpToInt64_v4(ByVal ipAddress As String) As Int64

Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress

Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean

Sub PrintExceptions(ex As Exception)

End Interface

Public Class IPUtils

Implements IIPUtils

#Region "Functions"

Public Function GetCIDRNetworkFromStartAndStopIpAddresses_v4(StartIP As String, StopIP As String) As String Implements IIPUtils.GetCIDRNetworkFromStartAndStopIpAddresses_v4

Dim cidr As StringBuilder = New StringBuilder

Dim startAddr As Long = Nothing

Dim endAddr As Long = Nothing

Try

' startAddr = &HC0A80001L ' 192.168.0.1

' endAddr = &HC0A800FEL ' 192.168.0.254

startAddr = Me.IpAddrToLong(IPAddress.Parse(StartIP))

endAddr = Me.IpAddrToLong(IPAddress.Parse(StopIP))

' Determine all bits that are different between the two IPs

Dim diffs = startAddr Xor endAddr

' Now count the number of consecutive zero bits starting at the most significant

Dim bits = 32

Dim mask = 0

Do While diffs <> 0

' We keep shifting diffs right until it's zero (i.e. we've shifted all the non-zero bits off)

diffs >>= 1

' Every time we shift, that's one fewer consecutive zero bits in the prefix

bits -= 1

' Accumulate a mask which will have zeros in the consecutive zeros of the prefix and ones elsewhere

mask = (mask << 1) Or 1

Loop

' Construct the root of the range by inverting the mask and ANDing it with the start address

Dim root = startAddr And Not mask

' Finally, output the range

' Console.WriteLine("{0}.{1}.{2}.{3}/{4}", root >> 24, (root >> 16) And &HFF, (root >> 8) And &HFF, root And &HFF, bits)

cidr.Append((root >> 24) & ".")

cidr.Append(((root >> 16) And &HFF) & ".")

cidr.Append(((root >> 8) And &HFF) & ".")

cidr.Append((root And &HFF) & "/")

cidr.Append(bits)

Catch ex As Exception

PrintExceptions(ex)

End Try

Return cidr.ToString

End Function

Public Function GetCIDRNotationFromIpAndNetmask(ipAddress As String, netMask As String) As String Implements IIPUtils.GetCIDRNotationFromIpAndNetmask

Dim answer As String = Nothing

Try

Dim theIP As Net.IPAddress = Net.IPAddress.Parse(ipAddress)

Dim theMASK As Net.IPAddress = Net.IPAddress.Parse(netMask)

Dim ipL As Long = IpAddrToLong(theIP)

Dim maskL As Long = IpAddrToLong(theMASK)

'Convert Mask to CIDR(1-30)

Dim oneBit As Long = &H80000000L

Dim CIDR As Integer = 0

For x As Integer = 31 To 0 Step -1

If (maskL And oneBit) = oneBit Then CIDR += 1 Else Exit For

oneBit = oneBit >> 1

answer = Me.IpLongToIpString(ipL And maskL) & "/" & CIDR.ToString

Catch ex As Exception

PrintExceptions(ex)

End Try

Return answer

End Function

Public Function GetLastIpAddress_v4(StartAddress As String, NumberOfAddresses As Integer) As IPAddress Implements IIPUtils.GetLastIpAddress_v4

' example usage:

' Dim ipStartAddress As String = "1.2.3.0"

' Dim ipAddressesToAdd As Integer = "4096"

' Console.WriteLine("--------------------")

' Console.WriteLine("last ip: " & iu.GetLastAddress(ipStartAddress, ipAddressesToAdd).ToString)

' Console.WriteLine("--------------------")

' output:

' --------------------

' last ip: 1.2.19.0

' --------------------

' NOTE: for RIRs, we need to subtract 1 from end address... otherwise last address = first address of next range.

' easiest way to do this is to subtract 1 from the # of addresses:

NumberOfAddresses -= 1

Dim ipLast As IPAddress = Nothing

Try

ipLast = IPAddress.Parse(Me.IpLongToIpString(Me.IpAddrToLong(IPAddress.Parse(StartAddress)) + CLng(NumberOfAddresses)))

Catch ex As Exception

PrintExceptions(ex)

End Try

Return ipLast

End Function

Public Function ByteArrayToDecimal(ByVal bytes() As Byte) As Decimal Implements IIPUtils.ByteArrayToDecimal

'check that it is even possible to convert the array

If bytes.Count() <> 16 Then

Throw New Exception("A decimal must be created from exactly 16 bytes")

End If

'make an array to convert back to int32's

Dim bits(3) As Int32

For i As Integer = 0 To 15 Step 4

'convert every 4 bytes into an int32

bits(i \ 4) = BitConverter.ToInt32(bytes, i)

Next i

'Use the decimal's new constructor to

'create an instance of decimal

Return New Decimal(bits)

End Function

Public Function DecimalToByteArray(dec As Decimal) As Byte() Implements IIPUtils.DecimalToByteArray

'Load four 32 bit integers from the Decimal.GetBits function

Dim bits As Int32() = Decimal.GetBits(dec)

'Create a temporary list to hold the bytes

Dim bytes As New List(Of Byte)

'iterate each 32 bit integer

For Each i As Int32 In bits

'add the bytes of the current 32bit integer to the bytes list

bytes.AddRange(BitConverter.GetBytes(i))

'return the bytes list as an array

Return bytes.ToArray

End Function

Public Function ByteArrayToString(byteArray As Byte()) As String Implements IIPUtils.ByteArrayToString

Dim r As StringBuilder = New StringBuilder()

Try

For Each b As Byte In byteArray

Console.WriteLine("{0} = {1}", b, ChrW(b))

Catch ex As FormatException

Log.Fatal("FormatException caught:")

Log.Fatal("Source: " & ex.Source)

Log.Fatal("Message: " & ex.Message)

Log.Fatal("Stack: " & ex.StackTrace)

Catch ex As Exception

Log.Fatal("Exception caught")

Log.Fatal("Source: " & ex.Source)

Log.Fatal("Message: " & ex.Message)

Log.Fatal("Stack: " & ex.StackTrace)

End Try

Return r.ToString

End Function

Public Function CompressIpToString_v46(ipAddr As String) As String Implements IIPUtils.CompressIpToString_v46

Dim address As IPAddress = Nothing

Try

' Create an instance of IPAddress for the specified address string (in

' dotted-quad, or colon-hexadecimal notation).

address = IPAddress.Parse(ipAddr)

Catch ex As Exception

PrintExceptions(ex)

End Try

Return address.ToString

End Function 'parse

Public Function CompressIpStringToIPaddress_v46(ipAddr As String) As System.Net.IPAddress Implements IIPUtils.CompressIpStringToIPaddress_v46

Dim address As IPAddress = Nothing

Try

' Create an instance of IPAddress for the specified address string (in

' dotted-quad, or colon-hexadecimal notation).

address = IPAddress.Parse(ipAddr)

Catch e As Exception

PrintExceptions(e)

End Try

Return address

End Function 'parse

Public Function ExpandShortIpStringToString_v46(shortIpAddress As String) As String Implements IIPUtils.ExpandShortIpStringToString_v46

Dim uncompressed As String = ""

Try

Dim addr As IPAddress = IPAddress.Parse(shortIpAddress)

If addr.AddressFamily = AddressFamily.InterNetworkV6 Then ' v6

Dim bytes() As Byte = addr.GetAddressBytes()

System.Diagnostics.Debug.Assert(bytes.Length = 16, "bytes.Length == 16")

Dim bldr As New System.Text.StringBuilder()

For i As Integer = 0 To 15 Step 2

bldr.AppendFormat("{0:x2}{1:x2}:", bytes(i), bytes(i + 1))

Next i

bldr.Length = bldr.Length - 1 'last colon

uncompressed = bldr.ToString()

Else ' v4

uncompressed = shortIpAddress

End If

Catch ex As Exception

PrintExceptions(ex)

End Try

Return uncompressed

End Function

Public Function GetByteArrayFromString(aString As String) As Byte() Implements IIPUtils.GetByteArrayFromString

Dim baResult() As Byte = {}

Try

' XXX shouldn't I be taking the "." out for v4?

baResult = System.Text.Encoding.ASCII.GetBytes(aString)

Catch ex As FormatException

Log.Fatal("GetByteArrayFromString(" & aString & ") FormatException caught!!!")

Log.Fatal("GetByteArrayFromString(" & aString & ") Message : " + ex.Message)

Log.Fatal("GetByteArrayFromString(" & aString & ") ToString : " + ex.ToString)

Log.Fatal("GetByteArrayFromString(" & aString & ") Source : " + ex.Source)

Catch ex As Exception

Log.Fatal("GetByteArrayFromString(" & aString & ") Exception caught!!!")

Log.Fatal("GetByteArrayFromString(" & aString & ") Message : " + ex.Message)

Log.Fatal("GetByteArrayFromString(" & aString & ") ToString : " + ex.ToString)

Log.Fatal("GetByteArrayFromString(" & aString & ") Source : " + ex.Source)

End Try

Return baResult

End Function

Public Function IpStringAndMaskToCidrAsString_v4(ipAddress As String, ipNetmask As String) As String Implements IIPUtils.IpStringAndMaskToCidrAsString_v4

Dim sCidr As String = ""

Try

Dim someIP As Net.IPAddress = Net.IPAddress.Parse(ipAddress)

Dim someMASK As Net.IPAddress = Net.IPAddress.Parse(ipNetmask)

Dim ipL As Long = Me.IpAddrToLong(someIP)

Dim maskL As Long = IpAddrToLong(someMASK)

'Convert Mask to CIDR(1-30)

Dim oneBit As Long = &H80000000L

Dim CIDR As Integer = 0

For x As Integer = 31 To 0 Step -1

If (maskL And oneBit) = oneBit Then CIDR += 1 Else Exit For

oneBit = oneBit >> 1

sCidr = Me.IpLongToIpString(ipL And maskL) & " /" & CIDR.ToString

Catch ex As Exception

PrintExceptions(ex)

End Try

Return sCidr

End Function

Public Function IpAddrToLong(ByVal theIP As Net.IPAddress) As Long Implements IIPUtils.IpAddrToLong 'convert IP to number

Dim addr As Long 'accumulator for address

Try

Dim IPb() As Byte = theIP.GetAddressBytes 'get the octets

For x As Integer = 0 To 3

addr = addr Or (CLng(IPb(x)) << (3 - x) * 8)

Catch ex As Exception

PrintExceptions(ex)

End Try

Return addr

End Function

Public Function MaskLongFromCidrInt(ByVal CIDR As Integer) As Long Implements IIPUtils.MaskLongFromCidrInt

MaskLongFromCidrInt = CLng(2 ^ ((32 - CIDR)) - 1) Xor 4294967295L

End Function

Public Function IpLongToIpString(ByVal theIP As Long) As String Implements IIPUtils.IpLongToIpString ' convert number back to IP

Dim IPb(3) As Byte '4 octets

Dim addr As String = "" 'accumulator for address

Dim mask8 As Long = Me.MaskLongFromCidrInt(8) 'create eight bit mask

For x = 0 To 3 'get the octets

IPb(x) = CByte((theIP And mask8) >> ((3 - x) * 8))

mask8 = mask8 >> 8

addr &= IPb(x).ToString & "." 'add current octet to string

Return addr.TrimEnd("."c)

End Function

Public Function StringToBytesAsString(someAddress As String) As String Implements IIPUtils.StringToBytesAsString

Dim sbResult As StringBuilder = New StringBuilder

Try

Dim theBytes As [Byte]() = Me.GetByteArrayFromString(someAddress)

Dim i As Integer

For i = 0 To theBytes.Length - 1

sbResult.Append(theBytes(i))

Next i

Catch ex As Exception

PrintExceptions(ex)

End Try

Return sbResult.ToString

End Function

Public Function IsIpAddress_v4(ByVal ipAddress As String) As Boolean Implements IIPUtils.IsIpAddress_v4

If New System.Text.RegularExpressions.Regex("^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$").Match(ipAddress).Success = False Then Return False

Return System.Net.IPAddress.TryParse(ipAddress, Nothing)

End Function

Public Function IpToInt64_v4(ByVal ipAddress As String) As Int64 Implements IIPUtils.IpToInt64_v4

Dim ipBytes = ipAddress.Split(".")

Return (ipBytes(0) << 24) Or (ipBytes(1) << 16) Or (ipBytes(2) << 8) Or (ipBytes(3))

End Function

Public Function Int64ToIp_v4(ByVal ipAddress As Int64) As String Implements IIPUtils.Int64ToIp_v4

Return System.Net.IPAddress.Parse(ipAddress.ToString).ToString

End Function

Public Function IpToScope_v4(ByVal ipAddress As String, ByVal subnetMask As String) As String Implements IIPUtils.IpToScope_v4

Return Int64ToIp_v4(IpToInt64_v4(ipAddress) And IpToInt64_v4(subnetMask))

End Function

Public Function HostToIP_v4(ByVal hostName As String) As String Implements IIPUtils.HostToIP_v4

Try

Return System.Net.Dns.GetHostAddresses(hostName)(0).ToString()

Catch ex As Exception

Return ""

End Try

End Function

Public Function IpAsStringToNetIpAddress(theIpAddress As String) As Net.IPAddress Implements IIPUtils.IpAsStringToNetIpAddress

Return IPAddress.Parse(theIpAddress)

End Function

Public Function IsAddressStringBetweenIpStrings(theIp As String, firstIp As String, lastIp As String) As Boolean Implements IIPUtils.IsAddressStringBetweenIpStrings

Dim result As Boolean = False

Try

Dim rangeStart As Net.IPAddress = Net.IPAddress.Parse(firstIp)

Dim rangeEnd As Net.IPAddress = Net.IPAddress.Parse(lastIp)

Dim check As Net.IPAddress = Net.IPAddress.Parse(theIp)

'get the bytes of the address

Dim rbs() As Byte = rangeStart.GetAddressBytes

Dim rbe() As Byte = rangeEnd.GetAddressBytes

Dim cb() As Byte = check.GetAddressBytes

'reverse them for conversion

Array.Reverse(rbs)

Array.Reverse(rbe)

Array.Reverse(cb)

'convert them

Dim rs As UInt32 = BitConverter.ToUInt32(rbs, 0)

Dim re As UInt32 = BitConverter.ToUInt32(rbe, 0)

Dim chk As UInt32 = BitConverter.ToUInt32(cb, 0)

'check

If chk >= rs AndAlso chk <= re Then

result = True

End If

Catch ex As Exception

Me.PrintExceptions(ex)

End Try

Return result

End Function

Function IpAddrStringToByteArray(theIpString As String) As Byte() Implements IIPUtils.IpAddrStringToByteArray

Dim result As Byte() = Nothing

Try

result = Me.IpAsStringToNetIpAddress(theIpString).GetAddressBytes()

Catch ex As Exception

PrintExceptions(ex)

End Try

Return result

End Function

#End Region

#Region "Subs"

Private Sub PrintExceptions(ex As Exception) Implements IIPUtils.PrintExceptions

Try

Dim exType As Type = ex.GetType

Log.Debug("-----start-----")

Log.Debug("Exception caught: " & exType.ToString)

If exType.ToString = "System.FormatException" Then

Log.Debug("FormatException caught:")

ElseIf exType.ToString = "System.ArgumentNullException" Then

Log.Error("ArgumentNullException caught:")

Else

Log.Error("Generic Exception caught:")

End If

Log.Debug("Source: " & ex.Source)

Log.Debug("Message: " & ex.Message)

Log.Debug("ToString: " & ex.ToString)

Log.Debug("Stack: " & ex.StackTrace)

Log.Debug("-----end-----")

Catch methodEx As Exception

Log.Fatal("methodEx.msg: " & methodEx.Message)

Log.Fatal("methodEx.tos: " & methodEx.ToString)

Log.Fatal("methodEx.stk: " & methodEx.StackTrace)

End Try

End Sub

Private Sub CursorWait()

Me.MW.Dispatcher.BeginInvoke(CType(Sub() Mouse.OverrideCursor = System.Windows.Input.Cursors.Wait, Action))

End Sub

Private Sub CursorArrow()

Me.MW.Dispatcher.BeginInvoke(CType(Sub() Mouse.OverrideCursor = System.Windows.Input.Cursors.Arrow, Action))

End Sub

Private Sub UpdateStatusLeft(UpdateText As String)

Try

If UpdateText.Length > 0 Then

Me.MW.Dispatcher.BeginInvoke(CType(Sub() Me.MW.StatusLeft.Text = UpdateText, Action))

End If

Catch ex As StackOverflowException

Log.Fatal("[UpdateStatusLeft()] StackOverflow (Message): ", ex.Message())

Log.Fatal("[UpdateStatusLeft()] StackOverflow (ToString): ", ex.ToString())

Log.Fatal("[UpdateStatusLeft()] StackOverflow (StackTrace): ", ex.StackTrace())

Catch ex As Exception

Log.Fatal("[UpdateStatusLeft()] Failed (Message): ", ex.Message())

Log.Fatal("[UpdateStatusLeft()] Failed (ToString): ", ex.ToString())

Log.Fatal("[UpdateStatusLeft()] Failed (StackTrace): ", ex.StackTrace())

End Try

End Sub

#End Region

End Class

End Namespace

Let me know if you have any additions or improvements!

pat
:)

The Sales Engineer

Sales Engineering University, Sales Consulting, World Domination & Youtube: The Sales Engineer

VB.NET IP Manipulation Utility Functions

Leave a Reply Cancel reply